Skip to main content
GET
/
sites
/
{siteId}
/
credentials
Get API credentials for a site
curl --request GET \
  --url https://api.altostrat.io/sites/{siteId}/credentials \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "b7a6c5d4-e3f2-1098-7654-3210abcdef98",
    "site_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "username": "altostrat-api",
    "password": "Extr3m3lyS3cur3P@ssw0rdG3n3r@t3d",
    "ip_address": "100.64.1.23",
    "api_port": 8728,
    "server_ip": "edge-us-east-1a.ostrat.io",
    "created_at": "2025-10-28T05:00:00Z",
    "updated_at": "2025-10-28T05:00:00Z"
  }
]

Authorizations

โ€‹
Authorization
string
header
required

Enter your JWT bearer token.

Path Parameters

โ€‹
siteId
string<uuid>
required

The unique identifier for the site.

Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

Response

An array containing the site's API credential object.

โ€‹
id
string<uuid>

The unique identifier for the credential set.

Example:

"b7a6c5d4-e3f2-1098-7654-3210abcdef98"

โ€‹
site_id
string<uuid>

The ID of the site these credentials belong to.

Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

โ€‹
username
string

The username for API access to the device.

Example:

"altostrat-api"

โ€‹
password
string

The password for API access to the device.

Example:

"Extr3m3lyS3cur3P@ssw0rdG3n3r@t3d"

โ€‹
ip_address
string<ipv4>

The private IP address of the device within the management tunnel.

Example:

"100.64.1.23"

โ€‹
api_port
integer

The API port configured on the device, as per its policy.

Example:

8728

โ€‹
server_ip
string

The hostname of the Altostrat management server managing the device's tunnel.

Example:

"edge-us-east-1a.ostrat.io"

โ€‹
created_at
string<date-time>

The timestamp when these credentials were created.

Example:

"2025-10-28T05:00:00Z"

โ€‹
updated_at
string<date-time>

The timestamp when these credentials were last updated.

Example:

"2025-10-28T05:00:00Z"