List key metadata containers (GET /v1/{tenant

Request headers

X-Auth-Token

Specify the authentication token.

Data type	Cardinality
String	1..1

Request parameters

limit

Maximum number of resources to return in the response (the default is 10)

Data type	Cardinality
int	0..1

offset

Starting index of resources to be listed (the default is 0)

Data type	Cardinality
int	0..1

Request body

None

Response headers

Status

The following error codes can be returned for the request.

One of the following values will be returned.

200:: Normal completion
401:: Authentication error (no authentication token, incorrect authentication token, etc.)
400:: Invalid access (invalid parameter, etc.)
403:: Cannot access (no privileges)
404:: No applicable resources
500:: Unexpected error

Data type	Cardinality
int	1..1

Response elements

containers

Envelope of key metadata container list

Data type	Cardinality	Parent element	Child element
Element	1..1	None	(container)

(container)

Envelope of key metadata container

Data type	Cardinality	Parent element	Child element
Element	0..*	containers	status updated name secret_refs

Data type

Cardinality

Parent element

Child element

Element

0..*

containers

status

updated

name

secret_refs

status

Status of key metadata container

Data type	Cardinality	Parent element	Child element
Enum(ACTIVE,ERROR)	1..1	(container)	None

updated

Timestamp (UTC) of last update

Data type	Cardinality	Parent element	Child element
datetime	1..1	(container)	None

name

Name of key metadata container

Data type	Cardinality	Parent element	Child element
String	1..1	(container)	None

created

Timestamp (UTC) of creation

Data type	Cardinality	Parent element	Child element
datetime	1..1	(container)	None

container_ref

Key metadata container resource URI

Data type	Cardinality	Parent element	Child element
String	1..1	(container)	None

secret_refs

Envelope of key metadata list registered in the key information container

Data type	Cardinality	Parent element	Child element
Element	1..1	None	(secret_ref_env)

(secret_ref_env)

Envelope of key metadata registered in the key information container

Data type	Cardinality	Parent element	Child element
Element	0..3	secret_refs	name secret_ref

name

The name of the key information for the key information container in which the key is registered

Data type	Cardinality	Parent element	Child element
String	1..1	(secret_ref_env)	None

secret_ref

URI of the key metadata registered in the key information container

Data type	Cardinality	Parent element	Child element
String	1..1	(secret_ref_env)	None

total

Number of key metadata containers registered for a project

Data type	Cardinality	Parent element	Child element
int	1..1	None	None

previous

The previous key metadata container resource offset information in the retrieved key metadata container list

Data type	Cardinality	Parent element	Child element
String	0..1	None	None

next

The next key metadata container resource offset in the retrieved key metadata container list

Data type	Cardinality	Parent element	Child element
String	0..1	None	None

Example of request


GET /v1/a759452216fd41cf8ee5aba321cfbd49/containers?limit=1&offset=2
X-Auth-Token: "JpZCI6ICJjM2VlNzA4YTZhZTI0ZGRmOTJjMDc4 . . ."

Example of response


Status Code: 200 OK
Content-Length: 647
Content-Type: application/json; charset=UTF-8

{
  "total": 4,
  "next": "http://<host>:9311/v1/a759452216fd41cf8ee5aba321cfbd49/containers?limit=1&offset=3",
  "containers": [
    {
      "status": "ACTIVE",
      "updated": "2014-07-18T04:41:34.245613",
      "name": "container1",
      "secret_refs": [
        {
          "secret_id": "82b63ed0-3ec7-4f3c-93b6-dde9a3c81b99",
          "name": "private_key"
        },
        {
          "secret_id": "e2c1ef34-2dac-4e77-8f20-3cd6386f9d87",
          "name": "intermediates"
        },
        {
          "secret_id": "e74530eb-0835-471a-ae05-392132ebce65",
          "name": "certificate"
        }
      ],
      "created": "2014-07-18T04:41:34.245607",
      "container_ref": "http://<host>:9311/v1/a759452216fd41cf8ee5aba321cfbd49/containers/ce0b7fcc-5963-47ba-bf44-3936e7b38381",
      "type": "certificate"
    }
  ],
  "previous": "http://<host>:9311/v1/a759452216fd41cf8ee5aba321cfbd49/containers?limit=1&offset=1"
}

List key metadata containers (GET /v1/{tenant_id}/containers)