https://api.katapult.io/core/v1/certificates/certificate/reset_token
| Code | Error | When it happens |
|---|---|---|
|
|
missing_api_token
|
No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer |
|
|
unauthorized_network_for_api_token
|
Network is not allowed to access the API with this API token |
|
|
invalid_api_token
|
The API token provided was not valid (it may not exist or have expired) |
|
|
token_owner_suspended
|
The user that owns the API token has been suspended |
|
|
invalid_capabilities_token
|
The capabilities token provided was not valid (either not valid, expired or not signed by the correct key) |
|
|
scope_not_granted
|
The scope required for this endpoint has not been granted to the authenticating identity |
|
|
permission_denied
|
The authenticated identity is not permitted to perform this action |
|
|
certificate_not_found
|
No certificate was found matching any of the criteria provided in the arguments |
|
|
object_in_trash
|
The object found is in the trash and therefore cannot be manipulated through the API. It should be restored in order to run this operation. |
|
|
rate_limit_reached
|
You have reached the rate limit for this type of request |
|
|
service_unavailable
|
The service is currently unavailable, please try again later |
certificate
object
required
body
id
string
certificate
object
id
string
name
string
additional_names
array
issuer
string
state
string
created_at
integer
expires_at
integer
last_issued_at
integer
issue_error
string
authorization_method
string
certificate_api_url
string
This is the URL that can be used to access this certificate's details. through the certificate API (a different API to this one). If null, this means that it is no longer available. If that is the case, you can get a new URL by resetting the API token for this certificate.
certificate
string
chain
string
private_key
string
{
"certificate": {
"id": "string",
"name": "string",
"additional_names": [],
"issuer": "lets_encrypt",
"state": "pending",
"created_at": 0,
"expires_at": 0,
"last_issued_at": 0,
"issue_error": "string",
"authorization_method": "string",
"certificate_api_url": "string",
"certificate": "string",
"chain": "string",
"private_key": "string"
}
}
Sent to https://api.katapult.io/core/v1 as a bearer token and never to Krystal Documentation. It isn't stored anywhere, so paste it again on each endpoint page.
Pre-filled with the endpoint's shape — declared defaults where it has them, otherwise a placeholder per type. Edit it before executing; the Arguments tab documents every field.