LOCKSS Configuration Service REST API

API of the LOCKSS Configuration REST Service
More information: https://www.lockss.org/
Contact Info: lockss-support@lockss.org
Version: 1.0.0
BasePath:/
BSD-3-Clause
https://www.lockss.org/support/open-source-license/

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

Aus

Config

Status

Aus

Up
delete /aus/{auid}
Delete the configuration of an AU (deleteAuConfig)
Delete the configuration of an AU given the AU identifier

Path parameters

auid (required)
Path Parameter — The identifier of the AU for which the configuration is\ \ to be deleted

Return type

auConfiguration

Example data

Content-Type: application/json
{
  "auId" : "auId",
  "auConfig" : {
    "key" : "auConfig"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The deleted configuration of the specified AU auConfiguration

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Up
get /aus
Get the configurations of all AUs (getAllAuConfig)
Get the configuration of all AUs

Return type

array[auConfiguration]

Example data

Content-Type: application/json
[ {
  "auId" : "auId",
  "auConfig" : {
    "key" : "auConfig"
  }
}, {
  "auId" : "auId",
  "auConfig" : {
    "key" : "auConfig"
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The configuration of all AUs

401

Unauthorized

500

Internal Server Error

Up
get /auagreements/{auid}
Get the poll agreements of an AU (getAuAgreements)
Get the poll agreements of an AU given the AU identifier

Path parameters

auid (required)
Path Parameter — The identifier of the AU for which the poll agreements\ \ are requested

Return type

String

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The poll agreements of the specified AU String

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

Up
get /aus/{auid}
Get the configuration of an AU (getAuConfig)
Get the configuration of an AU given the AU identifier

Path parameters

auid (required)
Path Parameter — The identifier of the AU for which the configuration is\ \ requested

Return type

auConfiguration

Example data

Content-Type: application/json
{
  "auId" : "auId",
  "auConfig" : {
    "key" : "auConfig"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The configuration of the specified AU auConfiguration

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

Up
get /austates/{auid}
Get the state of an AU (getAuState)
Get the state of an AU given the AU identifier

Path parameters

auid (required)
Path Parameter — The identifier of the AU for which the state is requested

Return type

String

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The state of the specified AU String

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

Up
patch /auagreements/{auid}
Upate the poll agreements of an AU (patchAuAgreements)
Update the poll agreements of an AU given the AU identifier

Path parameters

auid (required)
Path Parameter — The identifier of the AU for which the poll agreements\ \ are to be updated

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

auAgreements string (required)
Body Parameter — The parts of the Archival Unit poll agreements to be\ \ updated

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

Up
patch /austates/{auid}
Upate the state of an AU (patchAuState)
Update the state of an AU given the AU identifier

Path parameters

auid (required)
Path Parameter — The identifier of the AU for which the state is to be\ \ updated

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

auState string (required)
Body Parameter — The parts of the Archival Unit state to be updated

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

Up
put /aus/{auid}
Store the configuration of an AU (putAuConfig)
Store the configuration of an AU given the AU identifier

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

auConfiguration auConfiguration (required)
Body Parameter — The Archival Unit configuration to be stored

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

Config

Up
get /config/lastupdatetime
Get the timestamp when the configuration was last updated (getLastUpdateTime)
Get the timestamp when the configuration was last updated

Return type

Date

Example data

Content-Type: application/json
"2000-01-23T04:56:07.000+00:00"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The timestamp when the configuration was last updated Date

401

Unauthorized

500

Internal Server Error

Up
get /config/loadedurls
Get the URLs from which the configuration was loaded (getLoadedUrlList)
Get the URLs from which the configuration was actually\ \ loaded, reflecting any failover to local copies

Return type

array[String]

Example data

Content-Type: application/json
[ "", "" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The URLs from which the configuration was loaded

401

Unauthorized

500

Internal Server Error

Up
get /config/file/{sectionName}
Get the named configuration file (getSectionConfig)
Get the configuration file stored for a given name

Path parameters

sectionName (required)
Path Parameter — The name of the section for which the configuration file\ \ is requested

Request headers

Return type

File

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The named configuration file File

304

Not Modified

400

Bad Request

401

Unauthorized

404

Not Found

406

Not Acceptable

412

Precondition failed

500

Internal Server Error

Up
get /config/url
Get the configuration file for a URL (getUrlConfig)
Get the configuration file stored for a given URL

Request headers

Query parameters

url (required)
Query Parameter — The URL for which the configuration is requested

Return type

File

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The configuration file for the URL File

304

Not Modified

400

Bad Request

401

Unauthorized

404

Not Found

406

Not Acceptable

412

Precondition failed

500

Internal Server Error

Up
put /config/file/{sectionName}
Store the named configuration file (putConfig)
Store the configuration file for a given name

Path parameters

sectionName (required)
Path Parameter — The name of the section for which the configuration file\ \ is to be stored

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Form parameters

configFile (required)
Form Parameter — The configuration file to be stored

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition failed

415

Unsupported Media Type

500

Internal Server Error

Up
put /config/reload
Request a configuration reload (putConfigReload)
Request that the stored configuration is reloaded

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

401

Unauthorized

403

Forbidden

500

Internal Server Error

Status

Up
get /status
Get the status of the service (getStatus)
Get the status of the service

Return type

apiStatus

Example data

Content-Type: application/json
{
  "ready" : true,
  "version" : "version"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The status of the service apiStatus

401

Unauthorized

500

Internal Server Error

Models

[ Jump to Methods ]

Table of Contents

  1. apiStatus -
  2. auConfiguration -

apiStatus - Up

The status information of the service
version
String The version of the service
ready
Boolean The indication of whether the service is available

auConfiguration - Up

The encapsulation of an Archival Unit configuration
auId
String The identifier of the Archival Unit
auConfig
map[String, String] The map of Archival Unit configuration items