Description
Return an SSH key after use in PAM Core. The action releases the active checkout lease, which makes the key available to other consumers.
Prerequisites
- Authorization with read and write permission to PAM Core, granted by the administrator in A2A. For more information, access How to manage authorizations in A2A.
- A valid OAuth 2.0 access token. For more information, access How to authenticate an application in A2A.
Request
POST /api/v2/pam/ssh-keys/{id}/checkin
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | Yes | Unique identification code of the SSH key, assigned by Segura®. |
The request has no body.
Example request
POST {{url}}/api/v2/pam/ssh-keys/2267/checkin
Response
HTTP/1.1 204 No Content
The response has no body.
Errors
API v2 returns a structured code in the response body, alongside a human-readable message.
| HTTP code | Message | Possible cause | Solution |
|---|---|---|---|
401 |
api.auth.token.invalid |
The access token is missing, expired, or invalid. | Request a new access token and resend the request. |
403 |
api.permission.denied |
The authorization does not have write permission to PAM Core resources. | Ask the administrator to check the authorization permissions in A2A, then generate a new token. |
404 |
api.resource.not_found |
The SSH key does not exist, or it is outside the scope of the authorization. | Check the identification code sent in the path. |
429 |
rate_limit_exceeded |
The request rate limit was exceeded. | Reduce the request rate and try again. |
500 |
api.internal.error |
Internal server error. | Contact the Segura® support team. |
The specification does not say. The related checkout conflict code api.resource.conflict.checkout_active exists for the opposite case, but no code is defined for a check-in without an active lease. This error table is therefore incomplete.
For authentication error messages and the 403 versus 404 policy, access API v2 - Conventions and shared behaviors.