Get Authentication Info

Returns information about the authentication credentials being used to access the API

GET /auth/info

Try it

Get Authentication Info

cURL

curl --request GET \
  --url https://console.cloud.timescale.com/public/api/v1/auth/info \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "type": "apiKey",
  "apiKey": {
    "public_key": "tskey_abc123",
    "name": "my-production-token",
    "created": "2024-01-15T10:30:00Z",
    "project": {
      "id": "rp1pz7uyae",
      "name": "My Production Project",
      "plan_type": "FREE"
    },
    "issuing_user": {
      "id": "user123",
      "name": "John Doe",
      "email": "[e-mail]"
    }
  }
}

Authorizations

Authorization · string · header · required

HTTP Basic Authentication using your Tiger Cloud public key and secret key.

Format: Authorization: Basic <base64(public_key:secret_key)>

Example:

curl -X GET "https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services" \
  -H "Authorization: Basic $(echo -n 'your_public_key:your_secret_key' | base64)"

Response

200

application/json

Authentication information retrieved successfully.

type · enum<string> · required

The type of authentication being used

Available options: apiKey

Example:

"apiKey"

apiKey · object · required

Information about the API key credentials

Show child attributes

apiKey. public_key · string · required

The public key of the client credentials

Example:

"tskey_abc123"

apiKey. name · string · required

The name of the credential

Example:

"my-production-token"

apiKey. created · string<date-time> · required

When the client credentials were created

Example:

"2024-01-15T10:30:00Z"

apiKey. project · object · required

Information about the project

Show child attributes

apiKey.project. id · string · required

The project ID

Example:

"rp1pz7uyae"

apiKey.project. name · string · required

The name of the project

Example:

"My Production Project"

apiKey.project. plan_type · string · required

The plan type for the project

Example:

"FREE"

apiKey. issuing_user · object · required

Information about the user who created the credentials

Show child attributes

apiKey.issuing_user. id · string · required

The user ID

Example:

"user123"

apiKey.issuing_user. name · string · required

The user's name

Example:

"John Doe"

apiKey.issuing_user. email · string<email> · required

The user's email

Example:

"[e-mail]"