Skip to main content
POST
/
organizations
/
{organization}
/
service-tokens
Create a service token
curl --request POST \
  --url https://api.planetscale.com/v1/organizations/{organization}/service-tokens \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>"
}'
{
  "id": "<string>",
  "name": "<string>",
  "display_name": "<string>",
  "token": "<string>",
  "plain_text_refresh_token": "<string>",
  "avatar_url": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "expires_at": "<string>",
  "last_used_at": "<string>",
  "actor_id": "<string>",
  "actor_display_name": "<string>",
  "actor_type": "<string>",
  "service_token_accesses": [
    {
      "id": "<string>",
      "access": "<string>",
      "description": "<string>",
      "resource_name": "<string>",
      "resource_id": "<string>",
      "resource_type": "<string>",
      "resource": {
        "id": "<string>",
        "name": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "deleted_at": "<string>"
      }
    }
  ],
  "oauth_accesses_by_resource": {
    "database": {
      "databases": [
        {
          "name": "<string>",
          "id": "<string>",
          "organization": "<string>",
          "url": "<string>"
        }
      ],
      "accesses": [
        {
          "name": "<string>",
          "description": "<string>"
        }
      ]
    },
    "organization": {
      "organizations": [
        {
          "name": "<string>",
          "id": "<string>",
          "url": "<string>"
        }
      ],
      "accesses": [
        {
          "name": "<string>",
          "description": "<string>"
        }
      ]
    },
    "branch": {
      "branches": [
        {
          "name": "<string>",
          "id": "<string>",
          "database": "<string>",
          "organization": "<string>",
          "url": "<string>"
        }
      ],
      "accesses": [
        {
          "name": "<string>",
          "description": "<string>"
        }
      ]
    },
    "user": {
      "users": [
        {
          "name": "<string>",
          "id": "<string>"
        }
      ],
      "accesses": [
        {
          "name": "<string>",
          "description": "<string>"
        }
      ]
    }
  }
}

Authorizations

Authorization
string
header
required

Path Parameters

organization
string
required

Body

application/json
name
string

Response

id
string
required
name
string
required
display_name
string
required
token
string
required
plain_text_refresh_token
string
required
avatar_url
string
required
created_at
string
required
updated_at
string
required
expires_at
string
required
last_used_at
string
required
actor_id
string
required
actor_display_name
string
required
actor_type
string
required
service_token_accesses
object[]
required
oauth_accesses_by_resource
object
required