---
title: "Look up API token details"
method: GET
path: "/api_token_get_details"
tags: ["Authentication", "API Token Management"]
---

# Look up API token details

`GET /api_token_get_details`

This function looks up an API token’s details based on the token itself.

## Query parameters

- `token` string, required

## Response `200`

HTTP Request was successful.

- union
  - object
    - `data` object — The API token’s details. Only present if the system recognizes the given `token`.
      - `acls` string[] — A list of privileges assigned to the token.
      - `create_time` integer — The API token's creation time.
      - `expires_at` integer, nullable — The API token's expiration time. **Note:** A `null` value means that the API token does **not** expire.
      - `name` string — The API token's name.
      - `whitelist_ips` union[], nullable — List of remote IP or CIDR IP ranges this token may be used from.
        - union
          - string, ipv4
          - string, ipv6
          - string, cidr
    - `metadata` Metadata
      - `command` string — The method name called.
      - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
      - `result` 1 | 0 — * `1` — Success. * `0` – Failed. Check the `reason` field for more details.
      - `version` integer — The version of the API function.
  - object
    - `metadata` Metadata
      - `command` string — The method name called.
      - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
      - `result` 1 | 0 — * `1` — Success. * `0` – Failed. Check the `reason` field for more details.
      - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)