Management APIsΒΆ

SuperAdmin APIs are exposed by ARTESCA and expose a set of APIs to create, update, list or delete your ARTESCA accounts. Exposed on the management endpoint, they are consumed by Storage Managers.

Management APIs are exposed at the https://management.<base-domain>/swagger.json endpoint, as an OpenAPI standard Swagger Specification.

To visualize the supported endpoints, you can use any readily available swagger editor. The following APIs are supported by ARTESCA for a Storage Manager:

Category

Operation Type

Create an account

POST /api/v1/config/{uuid}/user

Delete an account

DELETE /api/v1/config/{uuid}/user

Regenerate an account secret key for an account

POST /api/v1/config/{uuid}/user/{accessKey}

Generate a set of access keys for an account

POST /api/v1/config/{uuid}/user/{accountName}/key

For each of these endpoints, you will have to provide an X-Authentication-Token header containing the value {token} and a {uuid}. To obtain this {token}, follow this procedure. The {uuid} is the instance ID of the same procedure.

A token is valid 5min (300 seconds).