Get My Instance​
Returns the details about the current instance such as the name, version, domains, etc.
- 200
- 403
- 404
- default
A successful response.
Schema
- Array [
- ]
instance 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
{
"instance": {
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:38.828Z",
"changeDate": "2024-06-13T06:44:38.828Z",
"resourceOwner": "69629023906488334"
},
"state": "STATE_UNSPECIFIED",
"name": "ZITADEL",
"version": "1.0.0",
"domains": [
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:38.828Z",
"changeDate": "2024-06-13T06:44:38.828Z",
"resourceOwner": "69629023906488334"
},
"domain": "zitadel.com",
"primary": true,
"generated": true
}
]
}
}
Schema
- Array [
- ]
instance 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
{
"instance": {
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:38.829Z",
"changeDate": "2024-06-13T06:44:38.829Z",
"resourceOwner": "69629023906488334"
},
"state": "STATE_UNSPECIFIED",
"name": "ZITADEL",
"version": "1.0.0",
"domains": [
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:38.829Z",
"changeDate": "2024-06-13T06:44:38.829Z",
"resourceOwner": "69629023906488334"
},
"domain": "zitadel.com",
"primary": true,
"generated": true
}
]
}
}
Schema
- Array [
- ]
instance 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
{
"instance": {
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:38.829Z",
"changeDate": "2024-06-13T06:44:38.829Z",
"resourceOwner": "69629023906488334"
},
"state": "STATE_UNSPECIFIED",
"name": "ZITADEL",
"version": "1.0.0",
"domains": [
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:38.829Z",
"changeDate": "2024-06-13T06:44:38.829Z",
"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"
}
]
}