List Instance Domains

Returns a list of domains that are configured for this ZITADEL instance. These domains are the URLs where ZITADEL is running.

Query Parameters

query.offset uint64
query.limit int64

Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

query.asc boolean

default is descending

sortingColumn string

Possible values: [DOMAIN_FIELD_NAME_UNSPECIFIED, DOMAIN_FIELD_NAME_DOMAIN, DOMAIN_FIELD_NAME_PRIMARY, DOMAIN_FIELD_NAME_GENERATED, DOMAIN_FIELD_NAME_CREATION_DATE]

Default value: DOMAIN_FIELD_NAME_UNSPECIFIED

the field the result is sorted

Responses

• 200
• 403
• 404
• default

---

A successful response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

details object

totalResult uint64

processedSequence uint64

viewTimestamp date-time

the last time the view got updated

sortingColumn string

Possible values: [DOMAIN_FIELD_NAME_UNSPECIFIED, DOMAIN_FIELD_NAME_DOMAIN, DOMAIN_FIELD_NAME_PRIMARY, DOMAIN_FIELD_NAME_GENERATED, DOMAIN_FIELD_NAME_CREATION_DATE]

Default value: DOMAIN_FIELD_NAME_UNSPECIFIED

result object[]
Array [
details object
sequence uint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
domain string
primary boolean
generated boolean
]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-04-09T11:59:31.955Z"
  },
  "sortingColumn": "DOMAIN_FIELD_NAME_UNSPECIFIED",
  "result": [
    {
      "details": {
        "sequence": "2",
        "creationDate": "2024-04-09T11:59:31.955Z",
        "changeDate": "2024-04-09T11:59:31.955Z",
        "resourceOwner": "69629023906488334"
      },
      "domain": "zitadel.com",
      "primary": true,
      "generated": true
    }
  ]
}

Schema

Example (from schema)

---

Schema

details object

totalResult uint64

processedSequence uint64

viewTimestamp date-time

the last time the view got updated

sortingColumn string

Possible values: [DOMAIN_FIELD_NAME_UNSPECIFIED, DOMAIN_FIELD_NAME_DOMAIN, DOMAIN_FIELD_NAME_PRIMARY, DOMAIN_FIELD_NAME_GENERATED, DOMAIN_FIELD_NAME_CREATION_DATE]

Default value: DOMAIN_FIELD_NAME_UNSPECIFIED

result object[]
Array [
details object
sequence uint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
domain string
primary boolean
generated boolean
]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-04-09T11:59:31.955Z"
  },
  "sortingColumn": "DOMAIN_FIELD_NAME_UNSPECIFIED",
  "result": [
    {
      "details": {
        "sequence": "2",
        "creationDate": "2024-04-09T11:59:31.955Z",
        "changeDate": "2024-04-09T11:59:31.955Z",
        "resourceOwner": "69629023906488334"
      },
      "domain": "zitadel.com",
      "primary": true,
      "generated": true
    }
  ]
}

Schema

Example (from schema)

---

Schema

details object

totalResult uint64

processedSequence uint64

viewTimestamp date-time

the last time the view got updated

sortingColumn string

Possible values: [DOMAIN_FIELD_NAME_UNSPECIFIED, DOMAIN_FIELD_NAME_DOMAIN, DOMAIN_FIELD_NAME_PRIMARY, DOMAIN_FIELD_NAME_GENERATED, DOMAIN_FIELD_NAME_CREATION_DATE]

Default value: DOMAIN_FIELD_NAME_UNSPECIFIED

result object[]
Array [
details object
sequence uint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
domain string
primary boolean
generated boolean
]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-04-09T11:59:31.955Z"
  },
  "sortingColumn": "DOMAIN_FIELD_NAME_UNSPECIFIED",
  "result": [
    {
      "details": {
        "sequence": "2",
        "creationDate": "2024-04-09T11:59:31.955Z",
        "changeDate": "2024-04-09T11:59:31.955Z",
        "resourceOwner": "69629023906488334"
      },
      "domain": "zitadel.com",
      "primary": true,
      "generated": true
    }
  ]
}

Returned when the user does not have permission to access the resource.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Returned when the resource does not exist.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

POST /domains/_search

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL

https://$CUSTOM-DOMAIN/admin/v1

Bearer Token

query.offset — query

query.limit — query

query.asc — query

---truefalse

sortingColumn — query

---DOMAIN_FIELD_NAME_UNSPECIFIEDDOMAIN_FIELD_NAME_DOMAINDOMAIN_FIELD_NAME_PRIMARYDOMAIN_FIELD_NAME_GENERATEDDOMAIN_FIELD_NAME_CREATION_DATE

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/domains/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

python / requests

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/domains/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

go / native

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/domains/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

nodejs / axios

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/domains/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

ruby / Net::HTTP

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/domains/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

csharp / RestSharp

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/domains/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

php / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/domains/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

java / OkHttp

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/domains/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

powershell / RestMethod

curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/domains/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'