Returns a list of ZITADEL instances​
Returns a list of ZITADEL instances
Request Body required
Search query for lists
- Array [
- ]
query object required
Object unspecific list filters like offset, limit and asc/desc.
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.
default is descending
Possible values: [FIELD_NAME_UNSPECIFIED
, FIELD_NAME_ID
, FIELD_NAME_NAME
, FIELD_NAME_CREATION_DATE
]
Default value: FIELD_NAME_UNSPECIFIED
queries object[]
idQuery object
4820840938402429
domainQuery object
Possible values: <= 20
Return the instances that have the requested domains
Request Body required
Search query for lists
- Array [
- ]
query object required
Object unspecific list filters like offset, limit and asc/desc.
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.
default is descending
Possible values: [FIELD_NAME_UNSPECIFIED
, FIELD_NAME_ID
, FIELD_NAME_NAME
, FIELD_NAME_CREATION_DATE
]
Default value: FIELD_NAME_UNSPECIFIED
queries object[]
idQuery object
4820840938402429
domainQuery object
Possible values: <= 20
Return the instances that have the requested domains
Request Body required
Search query for lists
- Array [
- ]
query object required
Object unspecific list filters like offset, limit and asc/desc.
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.
default is descending
Possible values: [FIELD_NAME_UNSPECIFIED
, FIELD_NAME_ID
, FIELD_NAME_NAME
, FIELD_NAME_CREATION_DATE
]
Default value: FIELD_NAME_UNSPECIFIED
queries object[]
idQuery object
4820840938402429
domainQuery object
Possible values: <= 20
Return the instances that have the requested domains
- 200
- 403
- 404
- default
A successful response.
Schema
- Array [
- Array [
- ]
- ]
details object
the last time the view got updated
Possible values: [FIELD_NAME_UNSPECIFIED
, FIELD_NAME_ID
, FIELD_NAME_NAME
, FIELD_NAME_CREATION_DATE
]
Default value: FIELD_NAME_UNSPECIFIED
result object[]
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [STATE_UNSPECIFIED
, STATE_CREATING
, STATE_RUNNING
, STATE_STOPPING
, STATE_STOPPED
]
Default value: STATE_UNSPECIFIED
current state of the instance
domains object[]
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-06-13T06:44:35.143Z"
},
"sortingColumn": "FIELD_NAME_UNSPECIFIED",
"result": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:35.143Z",
"changeDate": "2024-06-13T06:44:35.143Z",
"resourceOwner": "69629023906488334"
},
"state": "STATE_UNSPECIFIED",
"name": "ZITADEL",
"version": "1.0.0",
"domains": [
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:35.143Z",
"changeDate": "2024-06-13T06:44:35.143Z",
"resourceOwner": "69629023906488334"
},
"domain": "zitadel.com",
"primary": true,
"generated": true
}
]
}
]
}
Schema
- Array [
- Array [
- ]
- ]
details object
the last time the view got updated
Possible values: [FIELD_NAME_UNSPECIFIED
, FIELD_NAME_ID
, FIELD_NAME_NAME
, FIELD_NAME_CREATION_DATE
]
Default value: FIELD_NAME_UNSPECIFIED
result object[]
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [STATE_UNSPECIFIED
, STATE_CREATING
, STATE_RUNNING
, STATE_STOPPING
, STATE_STOPPED
]
Default value: STATE_UNSPECIFIED
current state of the instance
domains object[]
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-06-13T06:44:35.144Z"
},
"sortingColumn": "FIELD_NAME_UNSPECIFIED",
"result": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:35.144Z",
"changeDate": "2024-06-13T06:44:35.144Z",
"resourceOwner": "69629023906488334"
},
"state": "STATE_UNSPECIFIED",
"name": "ZITADEL",
"version": "1.0.0",
"domains": [
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:35.144Z",
"changeDate": "2024-06-13T06:44:35.144Z",
"resourceOwner": "69629023906488334"
},
"domain": "zitadel.com",
"primary": true,
"generated": true
}
]
}
]
}
Schema
- Array [
- Array [
- ]
- ]
details object
the last time the view got updated
Possible values: [FIELD_NAME_UNSPECIFIED
, FIELD_NAME_ID
, FIELD_NAME_NAME
, FIELD_NAME_CREATION_DATE
]
Default value: FIELD_NAME_UNSPECIFIED
result object[]
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [STATE_UNSPECIFIED
, STATE_CREATING
, STATE_RUNNING
, STATE_STOPPING
, STATE_STOPPED
]
Default value: STATE_UNSPECIFIED
current state of the instance
domains object[]
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-06-13T06:44:35.144Z"
},
"sortingColumn": "FIELD_NAME_UNSPECIFIED",
"result": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:35.145Z",
"changeDate": "2024-06-13T06:44:35.145Z",
"resourceOwner": "69629023906488334"
},
"state": "STATE_UNSPECIFIED",
"name": "ZITADEL",
"version": "1.0.0",
"domains": [
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:35.145Z",
"changeDate": "2024-06-13T06:44:35.145Z",
"resourceOwner": "69629023906488334"
},
"domain": "zitadel.com",
"primary": true,
"generated": true
}
]
}
]
}
Returned when the user does not have permission to access the resource.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}