GET | List a device

Description

Access the complete canonical model of a device registered in PAM Core, using the v2 API. Unlike the list endpoint, this endpoint returns every field of the DeviceV2 entity, including criticality, owner, administrator_group, network_connector, connectivities, and session_settings.

Prerequisites

• Authorization with read permission to PAM Core granted by the administrator in A2A. For more information, access How to manage authorizations in A2A.
• An existing device. To create one, access POST | Create device.

Request

GET /api/v2/platform/devices/{id}

Path parameters

Query parameters

Request headers

Example request

GET {{url}}/api/v2/platform/devices/55

Response

HTTP/1.1 200 OK

The response carries a strong ETag header representing the current state of the device, and an X-Request-Id header that correlates the request across Segura® logs. Save the ETag: it's required in the If-Match header of PUT | Update device and PATCH | Update device.

Every field of the canonical model is returned, including fields whose value is null. An inactive device returns 200 with active set to false.

Example response body

{
    "data": {
        "id": "55",
        "device": {
            "name": "db-prod-01",
            "address": "10.10.10.10",
            "active": true,
            "type": "Server",
            "vendor": "Oracle",
            "product": "Oracle Linux VM",
            "site": "SP-DC1",
            "domain_name": "CORP",
            "tags": ["prod", "database"],
            "criticality": "high",
            "owner": {
                "name": "John Doe"
            },
            "administrator_group": {
                "id": "5",
                "name": "PAM Admins"
            },
            "enable_remote_app": true,
            "network_connector": {
                "id": "12",
                "name": "NC-SP-01",
                "port": "50001"
            },
            "connectivities": [
                {
                    "protocol": "SSH",
                    "port": 22,
                    "connectable": true
                },
                {
                    "protocol": "RDP",
                    "port": 3389,
                    "connectable": false
                }
            ],
            "session_settings": [
                {
                    "connectivity": "SSH",
                    "expected_expression": "$",
                    "fill_in_value": "sudo su"
                }
            ]
        }
    },
    "meta": {
        "links": {
            "self": "/api/v2/platform/devices/55"
        },
        "actions": {
            "deactivate": "/api/v2/platform/devices/55/deactivate"
        }
    }
}

Response body fields

Errors

Example error response

404 the device doesn't exist or is outside the authorization scope:

{
    "error": {
        "code": "api.resource.not_found",
        "message": "The requested resource does not exist or is not accessible."
    }
}

Authentication errors

Related documents

• API v2 — Conventions and shared behaviors
• GET | List all devices
• GET | List device connection status
• PUT | Update device
• PATCH | Update device
• How to manage authorizations in A2A