POST/organization/certificates/{certificate_id}

Modify certificate

Modify a certificate. Note that only the name can be modified.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
certificate_idstringrequired
Unique ID of the certificate to modify.

The certificate modification payload.

namestringoptional
The updated name for the certificate

6 status codes
200Certificate modified successfully.
objectstringrequired
The object type. - If creating, updating, or getting a specific certificate, the object type is `certificate`. - If listing, activating, or deactivating certificates for the organization, the object type is `organization.certificate`. - If listing, activating, or deactivating certificates for a project, the object type is `organization.project.certificate`.
Allowed:certificateorganization.certificateorganization.project.certificate
idstringrequired
The identifier, which can be referenced in API endpoints
namestringrequired
The name of the certificate.
created_atintegerrequired
The Unix timestamp (in seconds) of when the certificate was uploaded.
certificate_detailsobjectrequired
activebooleanoptional
Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate.
400The request parameters are invalid or the requested operation cannot be performed.
errorobjectrequired
403The caller does not have permission to perform this operation.
errorobjectrequired
Details about the permission error.
404A certificate was not found in this organization.
errorobjectrequired
429The request was rejected because a rate limit was exceeded.
errorobjectrequired
500The certificate update could not be completed because of a server error.
errorobjectrequired

Error handling

A 400 is returned: The request parameters are invalid or the requested operation cannot be performed. A 403 is returned: The caller does not have permission to perform this operation. A 404 is returned: A certificate was not found in this organization. A 429 is returned: The request was rejected because a rate limit was exceeded. A 500 is returned: The certificate update could not be completed because of a server error.