List subdomains
subdomains
List subdomains
Lists all custom subdomains for the workspace associated with the Management API key.
GET
List subdomains
Returns a compact representation of each subdomain, without DNS records. Use Get subdomain to retrieve the DNS records and full details for a single subdomain.
Filter by
status to narrow the results, and use the cursor and limit parameters to page through them. See Pagination for details.
Note: Does not support Legacy subdomains. Migrate old certificates via the Dashboard to manage them via API.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Management API version.
Query Parameters
Filter by subdomain status
Available options:
pending, active, timed_out, failed Cursor token used for pagination. Response will contain items appearing after the given cursor.
Sets the maximum number of items contained in a single page.
Required range:
0 <= x <= 101