Skip to main content

Creates a new instance with all needed setup data​

This might take some time

Creates a new instance with all needed setup data This might take some time

Request Body required
    instanceName string
    firstOrgName string
    customDomain string
    human object
    userName string
    email object
    email string
    isEmailVerified boolean
    profile object
    firstName string
    lastName string
    preferredLanguage string
    password object
    password string
    passwordChangeRequired boolean
    machine object
    userName string
    name string
    personalAccessToken object
    expirationDate date-time

    The date the token will expire and no logins will be possible

    machineKey object
    type string

    Possible values: [KEY_TYPE_UNSPECIFIED, KEY_TYPE_JSON]

    Default value: KEY_TYPE_UNSPECIFIED

    expirationDate date-time

    The date the key will expire and no logins will be possible

    defaultLanguage string
Responses

A successful response.

Schema
    instanceId 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
    pat string
    machineKey byte
POST /instances/_create

Request

Base URL
https://$CUSTOM-DOMAIN/system/v1
Content-Type
Body required
{

  "instanceName": "string",

  "firstOrgName": "string",

  "customDomain": "string",

  "human": {

    "userName": "string",

    "email": {

      "email": "string",

      "isEmailVerified": true

    },

    "profile": {

      "firstName": "string",

      "lastName": "string",

      "preferredLanguage": "string"

    },

    "password": {

      "password": "string",

      "passwordChangeRequired": true

    }

  },

  "machine": {

    "userName": "string",

    "name": "string",

    "personalAccessToken": {

      "expirationDate": "2519-04-01T08:45:00.000000Z"

    },

    "machineKey": {

      "type": "KEY_TYPE_UNSPECIFIED",

      "expirationDate": "2519-04-01T08:45:00.000000Z"

    }

  },

  "defaultLanguage": "string"

}
Accept
curl / cURL
curl -L -X POST 'https://$CUSTOM-DOMAIN/system/v1/instances/_create' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "instanceName": "string",
  "firstOrgName": "string",
  "customDomain": "string",
  "human": {
    "userName": "string",
    "email": {
      "email": "string",
      "isEmailVerified": true
    },
    "profile": {
      "firstName": "string",
      "lastName": "string",
      "preferredLanguage": "string"
    },
    "password": {
      "password": "string",
      "passwordChangeRequired": true
    }
  },
  "machine": {
    "userName": "string",
    "name": "string",
    "personalAccessToken": {
      "expirationDate": "2519-04-01T08:45:00.000000Z"
    },
    "machineKey": {
      "type": "KEY_TYPE_UNSPECIFIED",
      "expirationDate": "2519-04-01T08:45:00.000000Z"
    }
  },
  "defaultLanguage": "string"
}'