v1

latestOpenAPI 3.1.0Apache 2.02026-07-178042197.1 KB
Objects

Register an Object instance

Request the service to create an Object instance on a new Storage Backend. Or add a new uncontrolled URL to get_urls.

To request the duplication of the Object to a new Storage Backend, clients POST a storage_id to this endpoint that does not currently have an instance of the Object. The API will then:

  • Allocate storage for Object objectId on Storage Backend storage_id
  • Copy the Object from an existing location to the newly allocated storage
  • Start advertising the new copy in get_urls once ready

The API instances SHOULD be capable of handling the case where the only existant instances are uncontrolled.

API instances SHALL NOT cascade the creation of new Object instances to initialisation Objects. Clients MUST initiate the creation of new Object instances of initialisation Objects directly.

Where a client has written a new uncontrolled Object instance, the client is responsible for ensuring that the Object written is complete and correct before registering it with this method.

All instances of an Object MUST be identical.

post/objects/{objectId}/instances

Path parameters

objectIdstring required

The Object identifier. The Object ID may include special characters such as / which should be URL encoded.

Request body

OR

Response

Object instance successfully registered.