Skip to main content

Get My Instance

GET 

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

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

Responses​

A successful response.

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
  • ]

curl -L 'https://$CUSTOM-DOMAIN/admin/v1/instances/me' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/admin/v1
Auth
ResponseClear

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