Get My Instance

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

Responses

200
403
404
default

A successful response.

application/json
application/grpc
application/grpc-web+proto

Schema
Example (from schema)

Schema

instance object
id string
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
state string
Possible values: [STATE_UNSPECIFIED, STATE_CREATING, STATE_RUNNING, STATE_STOPPING, STATE_STOPPED]
Default value: STATE_UNSPECIFIED
current state of the instance
name string
version string
domains 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
]

{
  "instance": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-10",
      "changeDate": "2023-05-10",
      "resourceOwner": "69629023906488334"
    },
    "state": "STATE_UNSPECIFIED",
    "name": "ZITADEL",
    "version": "1.0.0",
    "domains": [
      {
        "details": {
          "sequence": "2",
          "creationDate": "2023-05-10",
          "changeDate": "2023-05-10",
          "resourceOwner": "69629023906488334"
        },
        "domain": "zitadel.com",
        "primary": true,
        "generated": true
      }
    ]
  }
}

Schema
Example (from schema)

Schema

instance object
id string
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
state string
Possible values: [STATE_UNSPECIFIED, STATE_CREATING, STATE_RUNNING, STATE_STOPPING, STATE_STOPPED]
Default value: STATE_UNSPECIFIED
current state of the instance
name string
version string
domains 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
]

{
  "instance": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-10",
      "changeDate": "2023-05-10",
      "resourceOwner": "69629023906488334"
    },
    "state": "STATE_UNSPECIFIED",
    "name": "ZITADEL",
    "version": "1.0.0",
    "domains": [
      {
        "details": {
          "sequence": "2",
          "creationDate": "2023-05-10",
          "changeDate": "2023-05-10",
          "resourceOwner": "69629023906488334"
        },
        "domain": "zitadel.com",
        "primary": true,
        "generated": true
      }
    ]
  }
}

Schema
Example (from schema)

Schema

instance object
id string
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
state string
Possible values: [STATE_UNSPECIFIED, STATE_CREATING, STATE_RUNNING, STATE_STOPPING, STATE_STOPPED]
Default value: STATE_UNSPECIFIED
current state of the instance
name string
version string
domains 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
]

{
  "instance": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-10",
      "changeDate": "2023-05-10",
      "resourceOwner": "69629023906488334"
    },
    "state": "STATE_UNSPECIFIED",
    "name": "ZITADEL",
    "version": "1.0.0",
    "domains": [
      {
        "details": {
          "sequence": "2",
          "creationDate": "2023-05-10",
          "changeDate": "2023-05-10",
          "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"
    }
  ]
}

GET /instances/me

Authorization

type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud

Request

Base URL

https://$ZITADEL_DOMAIN/admin/v1

Bearer Token

Accept

curl -L -X GET 'https://$ZITADEL_DOMAIN/admin/v1/instances/me' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/admin/v1/instances/me' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/admin/v1/instances/me' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/admin/v1/instances/me' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/admin/v1/instances/me' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/admin/v1/instances/me' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/admin/v1/instances/me' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Get My Instance​

Authorization

Request

Get My Instance