Get My Instance

GET 
https://$CUSTOM-DOMAIN/admin/v1/instances/me

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Deprecated: use instance service v2 GetInstance instead.

Returns the details about the current instance such as the name, version, domains, etc.

Responses

200

A successful response.

application/json

Schema

Schema

instance object
idstring
Example: 69629023906488334
details object
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334
statestring
current state of the instance
Possible values: [STATE_UNSPECIFIED, STATE_CREATING, STATE_RUNNING, STATE_STOPPING, STATE_STOPPED]
Default value: STATE_UNSPECIFIED
namestring
Example: ZITADEL
versionstring
Example: 1.0.0
domains object[]
Array [
details object
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334
domainstring
Example: zitadel.com
primaryboolean
generatedboolean
]

Example (auto)

{
  "instance": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2024-07-29T15:51:28.071Z",
      "changeDate": "2024-07-29T15:51:28.071Z",
      "resourceOwner": "69629023906488334"
    },
    "state": "STATE_UNSPECIFIED",
    "name": "ZITADEL",
    "version": "1.0.0",
    "domains": [
      {
        "details": {
          "sequence": "2",
          "creationDate": "2024-07-29T15:51:28.071Z",
          "changeDate": "2024-07-29T15:51:28.071Z",
          "resourceOwner": "69629023906488334"
        },
        "domain": "zitadel.com",
        "primary": true,
        "generated": true
      }
    ]
  }
}

application/grpc

Schema

Schema

instance object
idstring
Example: 69629023906488334
details object
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334
statestring
current state of the instance
Possible values: [STATE_UNSPECIFIED, STATE_CREATING, STATE_RUNNING, STATE_STOPPING, STATE_STOPPED]
Default value: STATE_UNSPECIFIED
namestring
Example: ZITADEL
versionstring
Example: 1.0.0
domains object[]
Array [
details object
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334
domainstring
Example: zitadel.com
primaryboolean
generatedboolean
]

Example (auto)

{
  "instance": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2024-07-29T15:51:28.071Z",
      "changeDate": "2024-07-29T15:51:28.071Z",
      "resourceOwner": "69629023906488334"
    },
    "state": "STATE_UNSPECIFIED",
    "name": "ZITADEL",
    "version": "1.0.0",
    "domains": [
      {
        "details": {
          "sequence": "2",
          "creationDate": "2024-07-29T15:51:28.071Z",
          "changeDate": "2024-07-29T15:51:28.071Z",
          "resourceOwner": "69629023906488334"
        },
        "domain": "zitadel.com",
        "primary": true,
        "generated": true
      }
    ]
  }
}

application/grpc-web+proto

Schema

Schema

instance object
idstring
Example: 69629023906488334
details object
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334
statestring
current state of the instance
Possible values: [STATE_UNSPECIFIED, STATE_CREATING, STATE_RUNNING, STATE_STOPPING, STATE_STOPPED]
Default value: STATE_UNSPECIFIED
namestring
Example: ZITADEL
versionstring
Example: 1.0.0
domains object[]
Array [
details object
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334
domainstring
Example: zitadel.com
primaryboolean
generatedboolean
]

Example (auto)

{
  "instance": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2024-07-29T15:51:28.071Z",
      "changeDate": "2024-07-29T15:51:28.071Z",
      "resourceOwner": "69629023906488334"
    },
    "state": "STATE_UNSPECIFIED",
    "name": "ZITADEL",
    "version": "1.0.0",
    "domains": [
      {
        "details": {
          "sequence": "2",
          "creationDate": "2024-07-29T15:51:28.071Z",
          "changeDate": "2024-07-29T15:51:28.071Z",
          "resourceOwner": "69629023906488334"
        },
        "domain": "zitadel.com",
        "primary": true,
        "generated": true
      }
    ]
  }
}

403

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

application/json

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

application/grpc

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

application/grpc-web+proto

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

404

Returned when the resource does not exist.

application/json

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

application/grpc

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

application/grpc-web+proto

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

default

An unexpected error response.

application/json

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

application/grpc

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

application/grpc-web+proto

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

Authorization: oauth2

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"
    }
  }
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://$CUSTOM-DOMAIN/admin/v1/instances/me");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

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

Auth

Bearer Token

ResponseClear

Click the Send API Request button above and see the response here!