Upload
others
View
6
Download
0
Embed Size (px)
Citation preview
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 1/61
swagger Explore
RIO Brokerhttps://localhost:5050/api/openapi.json
RIO Broker REST API Copyright © 2018 SpectraLogic, Corp.
Spectra Logic Corp. - WebsiteSend email to Spectra Logic Corp.
devices-flashnet
HEADHEAD /api/devices/flashnet/{deviceName} Detects if a Flashnet device exists
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
deviceName *string
(path)
Device name
Responses Response content type application/json
Code Description
200 Flashnet device exists
https://localhost:5050
RIO Broker API 0.9.0
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 2/61
DELETEDELETE /api/devices/flashnet/{deviceName} Deletes a Flashnet device
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
deviceName *string
(path)
Device name. To determine the device name, use GET/api/devices/�ashnet.
Responses Response content type application/json
Code Description
204 Flashnet device deleted
GETGET /api/devices/flashnet/{deviceName} Get Flashnet device connection information.
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
deviceName *string
(path)
Device name. To determine the device name, use GET/api/devices/�ashnet.
required
required
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 3/61
Responses Response content type application/json
Code Description
200 Flashnet device retrieved
Model
POSTPOST /api/devices/flashnet Creates a new Flashnet device.
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
body *
(body)
Payload for creating a Flashnet device
Model
Parameter content type
application/json
Example Value
{ "name": "string", "endpoint": "string", "port": "string", "username": "string" }
required
required
Example Value
{ "name": "string", "endpoint": "string", "port": "string", "username": "string" }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 4/61
Responses Response content type application/json
Code Description
200 Flashnet device created
Model
GETGET /api/devices/flashnet Lists Flashnet devices
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
Responses Response content type application/json
Code Description
Example Value
{ "name": "string", "endpoint": "string", "port": "string", "username": "string" }
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 5/61
Code Description
200 Flastnet device list
Model
devices-marquis
HEADHEAD /api/devices/marquis/{deviceName} Detects if a Marquis Device exists
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
deviceName *string
(path)
Device name
Responses Response content type application/json
Code Description
Example Value
{ "devices": [ { "name": "string", "endpoint": "string", "port": "string", "username": "string" } ] }
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 6/61
Code Description
200 Marquis device exists
DELETEDELETE /api/devices/marquis/{deviceName} Deletes a Marquis device
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
deviceName *string
(path)
Device name
Responses Response content type application/json
Code Description
204 Marquis device deleted
GETGET /api/devices/marquis/{deviceName} Get Marquis device connection information.
Parameters Try it out
Name Description
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 7/61
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
deviceName *string
(path)
Device name
Responses Response content type application/json
Code Description
200 Marquis device retrieved
Model
POSTPOST /api/devices/marquis Creates a new Marquis device.
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
required
required
Example Value
{ "name": "string", "endpoint": "string", "tempStorage": "string" }
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 8/61
Name Description
body *
(body)
Payload for creating a marquis device
Model
Parameter content type
application/json
Responses Response content type application/json
Code Description
200 Marquis device created
Model
GETGET /api/devices/marquis Lists Marquis devices
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
required
Example Value
{ "name": "string", "endpoint": "string", "tempStorage": "string" }
Example Value
{ "name": "string", "endpoint": "string", "tempStorage": "string" }
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 9/61
Responses Response content type application/json
Code Description
200 Marquis device list
Model
devices-spectra
POSTPOST /api/devices/spectra Creates a new Spectra device.
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
Example Value
{ "devices": [ { "name": "string", "endpoint": "string", "tempStorage": "string" } ] }
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 10/61
Name Description
body *
(body)
Payload for creating a Spectra device
Model
Parameter content type
application/json
Responses Response content type application/json
Code Description
200 Spectra device created
Model
GETGET /api/devices/spectra Lists Spectra devices
Parameters Try it out
Name Description
required
Example Value
{ "name": "string", "mgmtInterface": "string", "username": "string", "password": "string", "dataPath": "string" }
Example Value
{ "name": "string", "mgmtInterface": "string", "username": "string" }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 11/61
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
Responses Response content type application/json
Code Description
200 Spectra device list
Model
HEADHEAD /api/devices/spectra/{deviceName} Detects if a Spectra device exists
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
deviceName *string
(path)
Device name
required
Example Value
{ "devices": [ { "name": "string", "mgmtInterface": "string", "username": "string" } ] }
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 12/61
Responses Response content type application/json
Code Description
200 Spectra device exists
DELETEDELETE /api/devices/spectra/{deviceName} Deletes a Spectra device
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
deviceName *string
(path)
Device name. To determine the device name, use GET/api/devices/spectra.
Responses Response content type application/json
Code Description
204 Spectra device deleted
GETGET /api/devices/spectra/{deviceName} Get Spectra device connection information.
Parameters Try it out
Name Description
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 13/61
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
deviceName *string
(path)
Device name. To determine the device name, use GET/api/devices/spectra.
Responses Response content type application/json
Code Description
200 Spectra device retrieved
Model
devices-storedURI
HEADHEAD /api/devices/storedURI/{deviceName} Detects if a Stored URI Device exists
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
required
required
Example Value
{ "name": "string", "mgmtInterface": "string", "username": "string" }
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 14/61
Name Description
deviceName *string
(path)
Device name
Responses Response content type application/json
Code Description
200 Stored URI device exists
DELETEDELETE /api/devices/storedURI/{deviceName} Deletes a Stored URI device
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
deviceName *string
(path)
Device name
Responses Response content type application/json
Code Description
204 Stored URI device deleted
required
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 15/61
GETGET /api/devices/storedURI/{deviceName} Get Stored URI device connection information.
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
deviceName *string
(path)
Device name
Responses Response content type application/json
Code Description
200 Stored URI device retrieved
Model
POSTPOST /api/devices/storedURI Creates a new Stored URI device.
Parameters Try it out
Name Description
required
required
Example Value
{ "name": "string", "alias": "string", "uri": "string" }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 16/61
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
body *
(body)
Payload for creating a stored URI device
Model
Parameter content type
application/json
Responses Response content type application/json
Code Description
200 Stored URI device created
Model
GETGET /api/devices/storedURI Lists Stored URI devices
Parameters Try it out
Name Description
required
required
Example Value
{ "name": "string", "alias": "string", "uri": "string" }
Example Value
{ "name": "string", "alias": "string", "uri": "string" }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 17/61
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
Responses Response content type application/json
Code Description
200 Stored URI device list
Model
authentication
POSTPOST /api/tokensAuthenticates a user and returns a token that is used with authenticated part of theAPI. The token must be passed in via the HTTP Authorization Header as a Bearertoken. For example: Authorization: Bearer aaa.bbb.ccc
Parameters Try it out
Name Description
required
Example Value
{ "devices": [ { "name": "string", "alias": "string", "uri": "string" } ] }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 18/61
Name Description
body *
(body)
Payload for obtaining an authentication token.
Model
Parameter content type
application/json
Responses Response content type application/json
Code Description
201 New Token response
Model
broker
POSTPOST /api/brokers/{brokerName}/agents Creates a new agent for a broker
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
required
Example Value
{ "username": "string", "password": "string" }
Example Value
{ "token": "string" }
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 19/61
Name Description
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
body *
(body)
Payload for creating a new agent for a broker.
Model
Parameter content type
application/json
Responses Response content type application/json
Code Description
201 New agent details
Model
GETGET /api/brokers/{brokerName}/agents Lists the agents for a broker
Parameters Try it out
Name Description
required
required
Example Value
{ "type": "string", "name": "string", "agentConfig": {} }
Example Value
{ "name": "string", "type": "string", "creationDate": "string", "lastIndexDate": "string", "agentConfig": {} }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 20/61
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
Responses Response content type application/json
Code Description
200 List agents response
Model
POSTPOST /api/brokers/{brokerName}/archive Creates an archive job
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eldshould be formatted as: Bearer aaa.bbb.ccc
required
required
Example Value
{ "agents": [ { "name": "string", "type": "string", "creationDate": "string", "lastIndexDate": "string", "agentConfig": {} } ] }
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 21/61
Name Description
brokerName. To determinethe broker name, use GET/api/brokers. *string
(path)
Broker name. To determine the broker name, use GET/api/brokers.
body *
(body)
Payload for creating an archive job.
Model
Parameter content type
application/json
upload-new-files-onlyboolean
(query)
If enabled, when a �le already exists in RIO it is ignored inthe archive job and no update occurs; only new �les areuploaded. Default = false.
fail-fastboolean
(query)
If enabled, when a validation error occurs the job failsimmediately. If disabled, the job continues even though avalidation error occurred. Default = true.
retryJobId
(query)
The UUID for the job to be retried.
Responses Response content type application/json
required
required
Example Value
{ "files": [ { "name": "string", "size": 0, "uri": "string", "metadata": {}, "relationships": [ null ], "indexMedia": true, "storeFileAttributes": true } ] }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 22/61
Code Description
201 Archive job response
Model
GETGET /api/brokers/{brokerName}/relationships Lists all the relationships for this broker
Parameters Try it out
Name Description
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
pageinteger
(query)
For paginated responses the page to return. Defaults to 0
per_pageinteger
(query)
The number of objects returned in a page. Defaults to 100.
Responses Response content type application/json
Example Value
{ "id": "string", "creationDate": "string", "lastUpdated": "string", "status": { "message": "string", "status": "active", "reason": "string" }, "jobType": "archive", "numberOfFiles": 0, "filesTransferred": 0, "totalSizeInBytes": 0, "bytesTransferred": 0, "progress": 0 }
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 23/61
Code Description
200
HEADHEAD /api/brokers/{brokerName}/agents/{agentName} Determines if an agent exists in a broker
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
agentName *string
(path)
Agent name
Responses Response content type application/json
Code Description
200
DELETEDELETE /api/brokers/{brokerName}/agents/{agentName}Deletes an agent from a broker. Onlyreadonly agents can be deleted
Parameters Try it out
Name Description
required
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 24/61
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
agentName *string
(path)
Agent name. To determine the broker name, use GET/api/brokers/{brokerName}/agents.
Responses Response content type application/json
Code Description
204
PUTPUT /api/brokers/{brokerName}/agents/{agentName} Updates an agent in a broker
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
agentName *string
(path)
Agent name. To determine the broker name, use GET/api/brokers/{brokerName}/agents.
required
required
required
required
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 25/61
Name Description
indexboolean
(query)
If enabled, the agent index is modi�ed to add content that wasadded since the last index operation. This does not overwriteexisting objects. Default = false
re-indexboolean
(query)
If enabled, the index operation starts scanning for new content thatwas added since the epoch (Thursday, 1 January 1970 UTC). Thisdoes not overwrite existing objects. Default = false
overwrite-indexboolean
(query)
If enabled, the re-index operation overwrites existing objects.Default = false
Responses Response content type application/json
Code Description
204
GETGET /api/brokers/{brokerName}/agents/{agentName} Returns details of the agent for the broker
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 26/61
Name Description
agentName *string
(path)
Agent name. To determine the broker name, use GET/api/brokers/{brokerName}/agents.
Responses Response content type application/json
Code Description
200 Agent details
Model
HEADHEAD /api/brokers/{brokerName} Determines if a broker exists
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
brokerName *string
(path)
Broker name
required
Example Value
{ "name": "string", "type": "string", "creationDate": "string", "lastIndexDate": "string", "agentConfig": {} }
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 27/61
Responses Response content type application/json
Code Description
200
DELETEDELETE /api/brokers/{brokerName} Deletes a broker
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
Responses Response content type application/json
Code Description
204
GETGET /api/brokers/{brokerName} Returns details about a broker
Parameters Try it out
Name Description
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 28/61
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
Responses Response content type application/json
Code Description
200 Broker Details
Model
POSTPOST /api/brokers/{brokerName}/restore Creates a restore job
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
required
required
Example Value
{ "name": "string", "creationDate": "string", "objectCount": 0 }
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 29/61
Name Description
body *
(body)
Payload for creating a restore job.
Model
Parameter content type
application/json
ignore-duplicatesboolean
(query)
If enabled, if the same �le is found across multiple brokers, the �rstmatch is restored. If disabled, when the same �le is found inmultiple brokers, the job creation fails. Default = false
fail-fastboolean
(query)
If enabled, when a validation error occurs the job fails immediately.If disabled, the job continues even though a validation erroroccurred. Default = true.
retryJobId
(query)
The UUID for the job to be retried.
Responses Response content type application/json
Code Description
required
Example Value
{ "files": [ { "name": "string", "uri": "string", "restoreFileProperties": true, "byteRange": { "startingIndex": 0, "endingIndex": 0 }, "timeCodeRange": "string" } ] }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 30/61
Code Description
201 Restore job response
Model
GETGET /api/brokers/{brokerName}/relationships/{relationshipName}Lists all of the objects in thespeci�ed relationship in abroker.
Parameters Try it out
Name Description
brokerName *string
(path)
Broker name. To determine the broker name, use GET/api/brokers.
relationshipName *string
(path)
Relationship name. To determine the relationship name, useGET /api/brokers/{brokerName}/relationships.
pageinteger
(query)
For paginated responses the page to return. Defaults to 0
per_pageinteger
(query)
The number of objects returned in a page. Defaults to 100.
Example Value
{ "id": "string", "creationDate": "string", "lastUpdated": "string", "status": { "message": "string", "status": "active", "reason": "string" }, "jobType": "archive", "numberOfFiles": 0, "filesTransferred": 0, "totalSizeInBytes": 0, "bytesTransferred": 0, "progress": 0 }
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 31/61
Responses Response content type application/json
Code Description
200
GETGET /api/brokers/{brokerName}/objects Lists objects in a broker
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
sort_bystring
(query)
Specify the �eld by which to sort. Values: SHARON
sort_orderstring
(query)
Specify the sort direction. Values: SHARON
pageinteger
(query)
For paginated responses, the page to return. Default=0.
per_pageinteger
(query)
The number of objects returned in a page. Default=100.
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 32/61
Name Description
prefixstring
(query)
The pre�x search method is used for �nding any �les that start withthe pre�x.
filenamestring
(query)
Filename searching means just the last part of a path.
Responses Response content type application/json
Code Description
200 Object List
Model
POSTPOST /api/brokers Creates a new broker
Parameters Try it out
Example Value
{ "page": { "number": 0, "pageSize": 0, "totalPages": 0 }, "objects": [ { "name": "string", "size": "string", "broker": "string", "creationDate": "string", "metadata": {}, "relationships": [ null ], "checksum": { "hash": "string", "type": "string" } } ] }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 33/61
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
body *
(body)
Payload for creating a broker.
Model
Parameter content type
application/json
Responses Response content type application/json
Code Description
200 Broker Details
Model
GETGET /api/brokers Lists brokers
Parameters Try it out
Name Description
required
required
Example Value
{ "name": "string", "agentName": "string", "agentConfig": {} }
Example Value
{ "name": "string", "creationDate": "string", "objectCount": 0 }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 34/61
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
Responses Response content type application/json
Code Description
200 Broker list
Model
HEADHEAD /api/brokers/{brokerName}/objects/{objectName}Returns a 200 if the object exists, and a404 otherwise. There is no payloadassociated with this request.
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
required
Example Value
{ "brokers": [ { "name": "string", "creationDate": "string", "objectCount": 0 } ] }
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 35/61
Name Description
objectName *string
(path)
Object name
Responses Response content type application/json
Code Description
200
DELETEDELETE /api/brokers/{brokerName}/objects/{objectName} Deletes an object from a broker
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
objectName *string
(path)
Object name. To determine the object name, use GET/api/brokers/{brokerName}/objects.
Responses Response content type application/json
Code Description
required
required
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 36/61
Code Description
204
PUTPUT /api/brokers/{brokerName}/objects/{objectName} Update the changeable �elds of an object
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
objectName *string
(path)
Object name. To determine the object name, use GET/api/brokers/{brokerName}/objects.
body *
(body)
Payload for updating the changeable �elds of an object. Forexample the Metadata or Relationships
Model
Parameter content type
application/json
Responses Response content type application/json
required
required
required
required
Example Value
{ "metadata": {}, "relationships": [ null ] }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 37/61
Code DescriptionCode Description
200
GETGET /api/brokers/{brokerName}/objects/{objectName} Returns information about a single object
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
objectName *string
(path)
Object name. To determine the object name, use GET/api/brokers/{brokerName}/objects.
Responses Response content type application/json
Code Description
required
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 38/61
Code Description
200 Object List
Model
agent
POSTPOST /api/brokers/{brokerName}/agents Creates a new agent for a broker
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
Example Value
{ "name": "string", "size": "string", "broker": "string", "creationDate": "string", "metadata": {}, "relationships": [ null ], "checksum": { "hash": "string", "type": "string" } }
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 39/61
Name Description
body *
(body)
Payload for creating a new agent for a broker.
Model
Parameter content type
application/json
Responses Response content type application/json
Code Description
201 New agent details
Model
GETGET /api/brokers/{brokerName}/agents Lists the agents for a broker
Parameters Try it out
Name Description
required
Example Value
{ "type": "string", "name": "string", "agentConfig": {} }
Example Value
{ "name": "string", "type": "string", "creationDate": "string", "lastIndexDate": "string", "agentConfig": {} }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 40/61
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
Responses Response content type application/json
Code Description
200 List agents response
Model
HEADHEAD /api/brokers/{brokerName}/agents/{agentName} Determines if an agent exists in a broker
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
required
required
Example Value
{ "agents": [ { "name": "string", "type": "string", "creationDate": "string", "lastIndexDate": "string", "agentConfig": {} } ] }
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 41/61
Name Description
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
agentName *string
(path)
Agent name
Responses Response content type application/json
Code Description
200
DELETEDELETE /api/brokers/{brokerName}/agents/{agentName}Deletes an agent from a broker. Onlyreadonly agents can be deleted
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
agentName *string
(path)
Agent name. To determine the broker name, use GET/api/brokers/{brokerName}/agents.
Responses Response content type application/json
required
required
required
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 42/61
Code Description
204
PUTPUT /api/brokers/{brokerName}/agents/{agentName} Updates an agent in a broker
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
agentName *string
(path)
Agent name. To determine the broker name, use GET/api/brokers/{brokerName}/agents.
indexboolean
(query)
If enabled, the agent index is modi�ed to add content that wasadded since the last index operation. This does not overwriteexisting objects. Default = false
re-indexboolean
(query)
If enabled, the index operation starts scanning for new content thatwas added since the epoch (Thursday, 1 January 1970 UTC). Thisdoes not overwrite existing objects. Default = false
overwrite-indexboolean
(query)
If enabled, the re-index operation overwrites existing objects.Default = false
Responses Response content type application/json
required
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 43/61
Code Description
204
GETGET /api/brokers/{brokerName}/agents/{agentName} Returns details of the agent for the broker
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
agentName *string
(path)
Agent name. To determine the broker name, use GET/api/brokers/{brokerName}/agents.
Responses Response content type application/json
Code Description
200 Agent details
Model
required
required
required
Example Value
{ "name": "string", "type": "string", "creationDate": "string", "lastIndexDate": "string", "agentConfig": {} }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 44/61
jobs
POSTPOST /api/brokers/{brokerName}/archive Creates an archive job
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eldshould be formatted as: Bearer aaa.bbb.ccc
brokerName. To determinethe broker name, use GET/api/brokers. *string
(path)
Broker name. To determine the broker name, use GET/api/brokers.
body *
(body)
Payload for creating an archive job.
Model
Parameter content type
application/json
upload-new-files-onlyboolean
(query)
If enabled, when a �le already exists in RIO it is ignored inthe archive job and no update occurs; only new �les areuploaded. Default = false.
required
required
required
Example Value
{ "files": [ { "name": "string", "size": 0, "uri": "string", "metadata": {}, "relationships": [ null ], "indexMedia": true, "storeFileAttributes": true } ] }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 45/61
Name Description
fail-fastboolean
(query)
If enabled, when a validation error occurs the job failsimmediately. If disabled, the job continues even though avalidation error occurred. Default = true.
retryJobId
(query)
The UUID for the job to be retried.
Responses Response content type application/json
Code Description
201 Archive job response
Model
GETGET /api/jobs Lists the jobs in RIO
Parameters Try it out
Name Description
Example Value
{ "id": "string", "creationDate": "string", "lastUpdated": "string", "status": { "message": "string", "status": "active", "reason": "string" }, "jobType": "archive", "numberOfFiles": 0, "filesTransferred": 0, "totalSizeInBytes": 0, "bytesTransferred": 0, "progress": 0 }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 46/61
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
job_typestring
(query)
The type of job to include in the search. Values: archive, restore,migration. To include more than one type, include multiple job_typeparameters.
statusstring
(query)
The status of job to include in the search. Values: active, completed,paused, canceled, error. To include more than one status, includemultiple status parameters.
brokerstring
(query)
Filter jobs to only include those pertaining to the speci�ed broker.To include more than one broker, include multiple brokerparameters.
Responses Response content type application/json
Code Description
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 47/61
Code Description
200 Job list
Model
POSTPOST /api/brokers/{brokerName}/restore Creates a restore job
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
brokerName *string
(path)
Broker name. To determine the broker name, use GET /api/brokers.
Example Value
{ "jobs": [ { "id": "string", "creationDate": "string", "lastUpdated": "string", "status": { "message": "string", "status": "active", "reason": "string" }, "jobType": "archive", "numberOfFiles": 0, "filesTransferred": 0, "totalSizeInBytes": 0, "bytesTransferred": 0, "progress": 0 } ] }
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 48/61
Name Description
body *
(body)
Payload for creating a restore job.
Model
Parameter content type
application/json
ignore-duplicatesboolean
(query)
If enabled, if the same �le is found across multiple brokers, the �rstmatch is restored. If disabled, when the same �le is found inmultiple brokers, the job creation fails. Default = false
fail-fastboolean
(query)
If enabled, when a validation error occurs the job fails immediately.If disabled, the job continues even though a validation erroroccurred. Default = true.
retryJobId
(query)
The UUID for the job to be retried.
Responses Response content type application/json
Code Description
required
Example Value
{ "files": [ { "name": "string", "uri": "string", "restoreFileProperties": true, "byteRange": { "startingIndex": 0, "endingIndex": 0 }, "timeCodeRange": "string" } ] }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 49/61
Code Description
201 Restore job response
Model
HEADHEAD /api/jobs/{jobId} Determines if the job exists
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
jobId *string
(path)
The UUID for the job.
Responses Response content type application/json
Code Description
Example Value
{ "id": "string", "creationDate": "string", "lastUpdated": "string", "status": { "message": "string", "status": "active", "reason": "string" }, "jobType": "archive", "numberOfFiles": 0, "filesTransferred": 0, "totalSizeInBytes": 0, "bytesTransferred": 0, "progress": 0 }
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 50/61
Code Description
200
PUTPUT /api/jobs/{jobId} Updates a job
Parameters Try it out
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
jobId *string
(path)
The UUID for the job. To determine the UUID for a job, use GET/api/jobs.
cancel *boolean
(query)
If enabled, the job is canceled.
Responses Response content type application/json
Code Description
200
GETGET /api/jobs/{jobId} Returns details about a job
Parameters Try it out
Name Description
required
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 51/61
Name Description
Authorization *string
(header)
The Bearer Token needed for authentication. The �eld should beformatted as: Bearer aaa.bbb.ccc
jobId *string
(path)
The UUID for the job. To determine the UUID for a job, use GET/api/jobs.
Responses Response content type application/json
Code Description
200 Job Details
Model
system
GETGET /api/system/keys/{keyHash} Returns details about a speci�c key
Parameters Try it out
required
required
Example Value
{ "id": "string", "creationDate": "string", "lastUpdated": "string", "status": { "message": "string", "status": "active", "reason": "string" }, "jobType": "archive", "numberOfFiles": 0, "filesTransferred": 0, "totalSizeInBytes": 0, "bytesTransferred": 0, "progress": 0, "files": [ null ] }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 52/61
Name Description
keyHash *string
(path)
Key Hash Parameter
Responses Response content type application/json
Code Description
200 RIO Key Details
Model
GETGET /api/system Returns system information
Parameters Try it out
No parameters
Responses Response content type application/json
Code Description
required
Example Value
{ "hash": "string", "creationDate": "string", "active": true }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 53/61
Code Description
200 Rio System Information
Model
GETGET /api/system/keys Lists of all the keys in RIO Broker
Parameters Try it out
No parameters
Responses Response content type application/json
Code Description
Example Value
{ "version": "string", "gitCommitHash": "string", "buildDate": "string", "server": { "jvm": { "version": "string", "vendor": "string", "vmVersion": "string", "vmName": "string" }, "operatingSystem": { "name": "string", "arch": "string", "version": "string", "cores": 0 } }, "runtimeStats": { "uptime": 0, "totalMemory": 0, "usedMemory": 0, "freeMemory": 0 } }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 54/61
Code Description
200 Rio Keys List
Model
cluster
GETGET /api/cluster/master Gets details about the master node in the cluster
Parameters Try it out
No parameters
Responses Response content type application/json
Code Description
200 Cluster details
Model
Example Value
{ "keys": [ { "hash": "string", "creationDate": "string", "active": true } ] }
Example Value
{ "ipAddress": "string", "clusterPort": 0, "httpPort": 0, "role": "string" }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 55/61
GETGET /api/cluster/members Lists all the members of the cluster
Parameters Try it out
No parameters
Responses Response content type application/json
Code Description
200 List cluster members
Model
POSTPOST /api/clusterThis call is used to either create a new cluster or join an existing cluster. To createa new cluster specify only the name. To join an existing cluster specify only the IPaddress. If both are speci�ed an error is returned.
Parameters Try it out
Name Description
ip *string
(query)
The IP address and HTTPS port for the master node of the cluster.
name *string
(query)
Name of the cluster to create
Example Value
{ "members": [ { "ipAddress": "string", "clusterPort": 0, "httpPort": 0, "role": "string" } ] }
required
required
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 56/61
Responses Response content type application/json
Code Description
201 Cluster created or joined successfully
Model
DELETEDELETE /api/clusterIf the node is a data node, then the node is removed from the cluster. If the nodeis the master node, then the cluster is deleted.
Parameters Try it out
No parameters
Responses Response content type application/json
Code Description
204 Successful deletion
GETGET /api/cluster Gets cluster details
Parameters Try it out
No parameters
Example Value
{ "clusterName": "string" }
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 57/61
Responses Response content type application/json
Code Description
200 Cluster details
Model
Models
Example Value
{ "clusterName": "string" }
system.serverResponse
system.osResponse
jobs.jobResponse
system.systemDetails
spectra.DeviceList
broker.listAgents
default.downstreamErrorMessage
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 58/61
flashnet.Device
range
broker.restoreJobFile
default.resourceErrorMessage
default.validationMessage
broker.agentDetails
broker.objectDetails
cluster.clusterMember
marquis.DeviceList
storedURI.CreateDevice
jobs.files
system.key
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 59/61
system.keysList
system.runtimeStats
spectra.Device
default.unsupportedMediaError
marquis.Device
broker.createArchiveJob
file.updateObject
agent.CreateAgent
pageInfo
jobs.detailedJobResponse
broker.BrokerList
broker.CreateBroker
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 60/61
storedURI.Device
storedURI.DeviceList
broker.archiveJobFile
spectra.CreateDevice
broker.BrokerDetails
default.validationErrorMessage
token.createTokenResponse
broker.createRestoreJob
jobs.jobList
cluster.memberList
flashnet.CreateDevice
token.createToken
1/8/2019 Swagger UI
https://localhost:5050/api/viewer/index.html?docExpansion=full 61/61
cluster.clusterResponse
broker.objectList
flashnet.DeviceList
marquis.CreateDevice
system.jvmResponse