TLS CA Certificates Swagger API

GET /archivist/v1/tlscacertificates

List TLS CA certificates

Returns a paginated list of TLS CA certificates

Query Parameters

• order_by (string) – Specify the sort order for the results.

• page_size (integer) – Maximum entries per page

• page_token (string) – The next_page_token returned from a previous list request if any.

• display_name (string) –

  Further fields are bound to query parameters and act to filter the result

  Customer friendly name for the TLS CA certificate.

Status Codes

• 200 OK – A successful response.

• 400 Bad Request – Returned when the request is badly formed.

• 401 Unauthorized – Returned when the user is not authenticated to the system.

• 403 Forbidden – Returned when the user is not authorized to read the TLS CA certificate.

• 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

• 500 Internal Server Error – Returned when the underlying storage system returns an error.

• default – An unexpected error response.

Response JSON Object

• next_page_token (string) – Token to retrieve the next page of results or empty if there are none.

• tlscacertificates[].display_name (string) – Customer friendly name for the TLS CA certificate.

• tlscacertificates[].identity (string) – Unique identification for the TLS CA ertificate, Relative Resource Name

• tlscacertificates[].tlscacertificate (string) – TLS CA Certificate as base64 string representing the contents of the PEM file

POST /archivist/v1/tlscacertificates

Upload a TLS CA certificate

This request uploads a TLS CA certificate. The display_name is the friendly name.

Request JSON Object

• display_name (string) – Customer friendly name for the TLS CA certificate. (required)

• tlscacertificate (string) – TLS CA Certificate as string representing the contents of the PEM file (required)

Status Codes

• 200 OK – A successful response.

• 400 Bad Request – Returned when the request is badly formed.

• 401 Unauthorized – Returned when the user is not authenticated to the system.

• 402 Payment Required – Returned when the user’s quota of certificates has been reached.

• 403 Forbidden – Returned when the user is not authorized to create a tlscacertificate.

• 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

• 500 Internal Server Error – Returned when the underlying storage system returns an error.

• default – An unexpected error response.

Response JSON Object

• display_name (string) – Customer friendly name for the TLS CA certificate.

• identity (string) – Unique identification for the TLS CA ertificate, Relative Resource Name

• tlscacertificate (string) – TLS CA Certificate as base64 string representing the contents of the PEM file

GET /archivist/v1/tlscacertificates/{uuid}

Get a TLS CA certificate

Returns the identified tlscacertificate

Parameters

• uuid (string) – Specify the TLS CA Certificate UUID where tlscacertificates/{uuid} is the TLS CA Certificate Identity e.g. 08838336-c357-460d-902a-3aba9528dd22 from Identity tlscacertificates/08838336-c357-460d-902a-3aba9528dd22

Status Codes

• 200 OK – A successful response.

• 400 Bad Request – Returned when the request is badly formed.

• 401 Unauthorized – Returned when the user is not authenticated to the system.

• 403 Forbidden – Returned when the user is not authorized to read the TLS CA certificate.

• 404 Not Found – Returned when the identified TLS CA certificate does not exist.

• 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

• 500 Internal Server Error – Returned when the underlying storage system returns an error.

• default – An unexpected error response.

Response JSON Object

• display_name (string) – Customer friendly name for the TLS CA certificate.

• identity (string) – Unique identification for the TLS CA ertificate, Relative Resource Name

• tlscacertificate (string) – TLS CA Certificate as base64 string representing the contents of the PEM file

DELETE /archivist/v1/tlscacertificates/{uuid}

Delete a TLS C Acertificate

Delete the identified tLS CA Certificate

Parameters

• uuid (string) – Specify the TLS CA Certificate UUID where tlscacertificates/{uuid} is the TLS CA Certificate Identity e.g. 08838336-c357-460d-902a-3aba9528dd22 from Identity tlscacertificates/08838336-c357-460d-902a-3aba9528dd22

Status Codes

• 200 OK – A successful response.

• 400 Bad Request – Returned when the request is badly formed.

• 401 Unauthorized – Returned when the user is not authenticated to the system.

• 403 Forbidden – Returned when the user is not authorized to delete the TLS CA certificate.

• 404 Not Found – Returned when the identified laccess policy does not exist.

• 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

• 500 Internal Server Error – Returned when the underlying storage system returns an error.

• default – An unexpected error response.

PATCH /archivist/v1/tlscacertificates/{uuid}

Update a TLS CA certificate’s details

Perform a full or partial update of the identified TLS CA certificate

Parameters

• uuid (string) – Specify the TLS CA Certificate UUID where tlscacertificates/{uuid} is the TLS CA Certificate Identity e.g. 08838336-c357-460d-902a-3aba9528dd22 from Identity tlscacertificates/08838336-c357-460d-902a-3aba9528dd22

Query Parameters

• mask (string) – The mask says exactly which fields are to be updated. This removes the ambiguity caused by ‘zero’ valued fields. https://grpc-ecosystem.github.io/grpc-gateway/docs/patch.html

Request JSON Object

• display_name (string) – Customer friendly name for the TLS CA certificate.

• identity (string) – Unique identification for the TLS CA ertificate, Relative Resource Name

• tlscacertificate (string) – TLS CA Certificate as base64 string representing the contents of the PEM file

Status Codes

• 200 OK – A successful response.

• 400 Bad Request – Returned when the request is badly formed.

• 401 Unauthorized – Returned when the user is not authenticated to the system.

• 403 Forbidden – Returned when the user is not authorized to update the TLS CA certificate.

• 404 Not Found – Returned when the identified TLS C Acertificate does not exist.

• 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

• 500 Internal Server Error – Returned when the underlying storage system returns an error.

• default – An unexpected error response.

Response JSON Object

• display_name (string) – Customer friendly name for the TLS CA certificate.

• identity (string) – Unique identification for the TLS CA ertificate, Relative Resource Name

• tlscacertificate (string) – TLS CA Certificate as base64 string representing the contents of the PEM file

GET /archivist/v1/tlscacertificates:caps

Get remaining capped resources for TLSCACertificates

Not stable or officially supported. Get remaining capped resources for TLSCACertificates

Status Codes

• 200 OK – A successful response.

• 401 Unauthorized – Returned when the user is not authenticated to the system.

• 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

• default – An unexpected error response.

Response JSON Object

• caps[].resource_remaining (string) – Number of capped resources remaining

• caps[].resource_type (string) – String identifying the capped resource type

GET /archivist/v1/tlscacertificates:openapi

Get OpenAPI spec for TLSCACertificates

Get OpenAPI v2.0 spec for TLSCACertificates

Status Codes

• 200 OK – A successful response.

• 401 Unauthorized – Returned when the user is not authenticated to the system.

• 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

• default – An unexpected error response.

GET /archivist/v1/tlscacertificates:openapi-ui

Get OpenAPI UI for TLSCACertificates

Get OpenAPI v2.0 UI for TLSCACertificates

Status Codes

• 200 OK – A successful response.

• 401 Unauthorized – Returned when the user is not authenticated to the system.

• 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

• default – An unexpected error response.