POST | Activate device

Prev Next

Description

Activate a device registered in PAM Core using the v2 API. Activation restores the device as an operational target, allowing write operations and sessions again.

Attention

Activation applies to the device only. Credentials that were deactivated by a previous POST | Deactivate device are not reactivated: reactivating them is the integrator's responsibility, and it must be done explicitly through the credentials API or the web interface.


Prerequisites

  • Authorization with write permission to PAM Core granted by the administrator in A2A. For more information, access How to manage authorizations in A2A.
  • An inactive device. Activating a device that is already active returns 409.

Request

POST /api/v2/platform/devices/{id}/activate

Info

This endpoint belongs to the A2A API v2 surface and is available from Segura® version 4.2.9. Devices are served from the /api/v2/platform base path, not from /api/v2/pam like other v2 resources. The v1 equivalent is documented in PUT | Enable device.

Path parameters

Field Type Required Description
id integer Yes Unique identification code of the device. Note: this value is assigned by Segura® in POST | Create device.

This action takes no request body, and it doesn't require the If-Match header that PUT | Update device and PATCH | Update device require.


Example request

POST {{url}}/api/v2/platform/devices/55/activate


Response

HTTP/1.1 204 No Content

The response has no body. To confirm the new state, retrieve the device with GET | List a device: device.active returns true, and meta.actions then exposes only deactivate.


Errors

HTTP code Message Possible cause Solution
401 api.auth.token.invalid The access token is missing or has expired. Request a new access token.
403 api.permission.denied The authorization doesn't 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 device doesn't exist, or it belongs to another tenant. Check the identification code sent in the path.
409 api.resource.conflict.already_active The device is already active. No action is needed, the device is already in the requested state.
429 rate_limit_exceeded The request rate limit was exceeded. Wait the number of seconds given in the Retry-After header, then retry.
500 api.internal.error Internal server error. Contact the Segura® support team.

Example error response

409 the device is already active:

{
    "error": {
        "code": "api.resource.conflict.already_active",
        "message": "Device is already active."
    }
}

Authentication errors

Message Possible cause Solution
Client authentication failed. Application authentication failure with the Segura® server. Check the authentication parameters (Access Token URL, Client ID, and Client secret) and request a new access token.
Invalid signature Failure in recognizing the client application URL. Check the URL of the client application and resend the request.
No route matched with those values. Missing authorization header in the API request. Request a new access token.
Request timed out. The request exceeded the timeout limit. Check the connectivity between the source of the request and the Segura® server.

Related documents