List API Tokens

List API Tokens

GET

/api/portal/v1/apiTokens

Description

List all API tokens visible to the authenticated user. The response includes tokens that the user created, as well as tokens created by other users within the same account.

Authentication

This endpoint requires a Bearer token in the Authorization header.

  • Authorization: Bearer <token>. A valid Portal API session token or API token.

Response Schema

The endpoint returns an array of API token records.

  • id: The bearer token string. Used to authenticate Core API and Portal API requests.
  • name: A human-readable label for the token.
  • userId: The ID of the user who created the token.
  • userEmail: The email of the user who created the token.
  • createdAt: Timestamp when the token was created, in milliseconds since unix epoch.
  • lastUsedAt: Timestamp of the most recent request authenticated by this token, in milliseconds since unix epoch. null if the token has never been used.
  • restrictions: An object describing limits on how the token can be used, or null if unrestricted. See Create API Token for the full schema.

Error Responses

  • 401 Unauthorized: The Authorization header is missing or the token is not valid.
Example Request
GET https://<your-host>:9909/api/portal/v1/apiTokens
Authorization: Bearer <token>

Example Response
Status Code: 200 OK
Response Body:
[
    {
        "id": "299ce9bf4f244300a96f3926240f9c0d",
        "name": "Development Token",
        "userId": 1,
        "userEmail": "example@zydromarine.com",
        "createdAt": 1736942400000,
        "lastUsedAt": 1736946000000,
        "restrictions": {
            "hosts": ["example.com"]
        }
    },
    {
        "id": "5f8e7d6c5b4a3210fedcba9876543210",
        "name": "Production Token",
        "userId": 1,
        "userEmail": "example@zydromarine.com",
        "createdAt": 1736942400000,
        "lastUsedAt": 1736946000000,
        "restrictions": null
    }
]
VectorCharts.com © 2024, Zydro Marine Technologies, Inc. · vectorcharts.com