Skip to main content
GET
List domains

Authorizations

Authorization
string
header
required

Send your API token as Authorization: Bearer <api-token>.

Query Parameters

teamID
string

Run the request in the context of a team you belong to, instead of your personal account. 24-character hexadecimal ID.

Pattern: ^[0-9a-fA-F]{24}$
type
enum<string>
default:PROJECT

PROJECT for an app's domain, BUCKET for an object storage bucket's domain.

Available options:
PROJECT,
BUCKET
project
string

Only list domains of this app (by name).

bucket
string

Only list domains of this bucket (by name).

domain
string

Only list domains whose name contains this text (letters, digits and dots).

page
integer

Page number, starting at 1. Use it together with count.

Required range: x >= 1
count
integer

Domains per page. Without it, all matching domains are returned.

Required range: x >= 1

Response

Your domains.

total
integer
domains
object[]