Using REST API in Managed Service for TimescaleDB

Managed Service for TimescaleDB has an API for integration and automation tasks. For information about using the endpoints, see the API Documentation. MST offers an HTTP API with token authentication and JSON-formatted data. You can use the API for all the tasks that can be performed using the web console. To get started you need to first create an authentication token, and then use the token in the header to use the API endpoints.

Creating an authentication token in Managed Service for TimescaleDB

  1. Log in to your Managed Service for TimescaleDB portal.
  2. Click User Information in the top right corner.
  3. In the User Profile page, navigate to the Authenticationtab.
  4. Click Generate Token.
  5. In the Generate access token dialog, type a descriptive name for the token and leave the rest of the fields blank.
  6. Copy the generated authentication token and save it.

Using cURL to get your details

  1. Set the environment variable MST_API_TOKEN with the access token that you generate:

    export MST_API_TOKEN="access token"
  2. To get the details about the current user session using the /me endpoint:

    curl -s -H "Authorization: aivenv1 $MST_API_TOKEN" https://api.aiven.io/v1/me|json_pp

    The output looks similar to this:

    {
    "user": {
    "auth": [],
    "create_time": "string",
    "features": { },
    "intercom": {},
    "invitations": [],
    "project_membership": {},
    "project_memberships": {},
    "projects": [],
    "real_name": "string",
    "state": "string",
    "token_validity_begin": "string",
    "user": "string",
    "user_id": "string"
    }
    }

Found an issue on this page?

Report an issue!

Keywords

Related Content