Get My Instance

GET 
/instances/me

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

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 (string)

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 (string)

domain string

primary boolean

generated boolean

]

Example (from schema)

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

application/grpc

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 (string)

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 (string)

domain string

primary boolean

generated boolean

]

Example (from schema)

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

application/grpc-web+proto

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 (string)

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 (string)

domain string

primary boolean

generated boolean

]

Example (from schema)

{
  "instance": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2024-07-31T12:22:56.105Z",
      "changeDate": "2024-07-31T12:22:56.105Z",
      "resourceOwner": "69629023906488334"
    },
    "state": "STATE_UNSPECIFIED",
    "name": "ZITADEL",
    "version": "1.0.0",
    "domains": [
      {
        "details": {
          "sequence": "2",
          "creationDate": "2024-07-31T12:22:56.105Z",
          "changeDate": "2024-07-31T12:22:56.105Z",
          "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

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

Loading...