TLS CA Certificates API

TLS CA Certificates API Reference

get  /archivist/v1/tlscacertificates

List TLS CA certificates

Description: Returns a paginated list of TLS CA certificates

{
  "page_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6InN0dW50aWR",
  "tlscacertificates": [
    {
      "display_name": "Some description",
      "identity": "tlscacertificates/08838336-c357-460d-902a-3aba9528dd22"
    }
  ]
}
Response Parameter Type Description
next_page_token string Token to retrieve the next page of results or empty if there are none.
tlscacertificates array Describes TLS CA certificate in PEM file format.
Responses Description
200A successful response.
400Returned when the request is badly formed.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to read the TLS CA certificate.
500Returned when the underlying storage system returns an error.
defaultAn unexpected error response.

post  /archivist/v1/tlscacertificates

Upload a TLS CA certificate

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

{
  "display_name": "Some description",
  "tlscacertificate": "-----BEGIN CERTIFICATE----- MIIEBDCCAuygAwIBAgIDAjppMA0GCSqGSIb3DQEBBQUAMEIxCzAJBgNVBAYTAlVT -----END CERTIFICATE-----"
}
Parameter Type Description
display_name string Customer friendly name for the TLS CA certificate.
tlscacertificate string TLS CA Certificate as string representing the contents of the PEM file

{
  "display_name": "Some description",
  "identity": "tlscacertificates/08838336-c357-460d-902a-3aba9528dd22",
  "tlscacertificate": "-----BEGIN CERTIFICATE----- MIIEBDCCAuygAwIBAgIDAjppMA0GCSqGSIb3DQEBBQUAMEIxCzAJBgNVBAYTAlVT -----END CERTIFICATE-----"
}
Response Parameter Type Description
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
Responses Description
200A successful response.
400Returned when the request is badly formed.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to create a tlscacertificate.
500Returned when the underlying storage system returns an error.
defaultAn unexpected error response.

delete  /archivist/v1/{identity}

Delete a TLS C Acertificate

Description: Delete the identified tLS CA Certificate

Responses Description
200A successful response.
400Returned when the request is badly formed.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to delete the TLS CA certificate.
404Returned when the identified laccess policy does not exist.
500Returned when the underlying storage system returns an error.
defaultAn unexpected error response.

get  /archivist/v1/{identity}

Get a TLS CA certificate

Description: Returns the identified tlscacertificate

{
  "display_name": "Some description",
  "identity": "tlscacertificates/08838336-c357-460d-902a-3aba9528dd22",
  "tlscacertificate": "-----BEGIN CERTIFICATE----- MIIEBDCCAuygAwIBAgIDAjppMA0GCSqGSIb3DQEBBQUAMEIxCzAJBgNVBAYTAlVT -----END CERTIFICATE-----"
}
Response Parameter Type Description
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
Responses Description
200A successful response.
400Returned when the request is badly formed.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to read the TLS CA certificate.
404Returned when the identified TLS CA certificate does not exist.
500Returned when the underlying storage system returns an error.
defaultAn unexpected error response.

patch  /archivist/v1/{identity}

Update a TLS CA certificate's details

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

{
  "display_name": "Some description",
  "identity": "tlscacertificates/08838336-c357-460d-902a-3aba9528dd22",
  "tlscacertificate": "-----BEGIN CERTIFICATE----- MIIEBDCCAuygAwIBAgIDAjppMA0GCSqGSIb3DQEBBQUAMEIxCzAJBgNVBAYTAlVT -----END CERTIFICATE-----"
}
Parameter Type Description
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

{
  "display_name": "Some description",
  "identity": "tlscacertificates/08838336-c357-460d-902a-3aba9528dd22",
  "tlscacertificate": "-----BEGIN CERTIFICATE----- MIIEBDCCAuygAwIBAgIDAjppMA0GCSqGSIb3DQEBBQUAMEIxCzAJBgNVBAYTAlVT -----END CERTIFICATE-----"
}
Response Parameter Type Description
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
Responses Description
200A successful response.
400Returned when the request is badly formed.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to update the TLS CA certificate.
404Returned when the identified TLS C Acertificate does not exist.
500Returned when the underlying storage system returns an error.
defaultAn unexpected error response.

Edit this page on GitHub