Skip to content
Docs

list_project_domains

Retrieve project domains by project by id or name.

ParameterTypeRequiredDescription
idOrNamestringYesThe unique project identifier or the project name
productionstringNoFilters only production domains when set to true. Allowed values: "true", "false". Default: "false".
targetstringNoFilters on the target of the domain. Can be either "production", "preview" Allowed values: "production", "preview".
customEnvironmentIdstringNoThe unique custom environment identifier within the project
gitBranchstringNoFilters domains based on specific branch.
redirectsstringNoExcludes redirect project domains when "false". Includes redirect project domains when "true" (default). Allowed values: "true", "false". Default: "true".
redirectstringNoFilters domains based on their redirect target.
verifiedstringNoFilters domains based on their verification status. Allowed values: "true", "false".
limitnumberNoMaximum number of domains to list from a request (max 100).
sincenumberNoGet domains created after this JavaScript timestamp.
untilnumberNoGet domains created before this JavaScript timestamp.
orderstringNoDomains sort order by createdAt Allowed values: "ASC", "DESC". Default: "DESC".
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.

Was this helpful?

supported.