Deprecated: Use CreateInstance instead Creates a new instance with all needed setup data This might take some time

POST 
https://$CUSTOM-DOMAIN/system/v1/instances

Deprecated: Use CreateInstance instead Creates a new instance with all needed setup data This might take some time

Request

application/json

Body

required

instanceName string
firstOrgName string
customDomain string
ownerUserName string

ownerEmail

object

email string

isEmailVerified boolean

ownerProfile

object

firstName string

lastName string

preferredLanguage string

ownerPassword

object

password string

passwordChangeRequired boolean
defaultLanguage string

application/grpc

Body

required

instanceName string
firstOrgName string
customDomain string
ownerUserName string

ownerEmail

object

email string

isEmailVerified boolean

ownerProfile

object

firstName string

lastName string

preferredLanguage string

ownerPassword

object

password string

passwordChangeRequired boolean
defaultLanguage string

application/grpc-web+proto

Body

required

instanceName string
firstOrgName string
customDomain string
ownerUserName string

ownerEmail

object

email string

isEmailVerified boolean

ownerProfile

object

firstName string

lastName string

preferredLanguage string

ownerPassword

object

password string

passwordChangeRequired boolean
defaultLanguage string

Responses

200

A successful response.

application/json

Schema

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

Example (from schema)

{
  "instanceId": "string",
  "details": {
    "sequence": "2",
    "creationDate": "2025-03-25T07:19:29.171Z",
    "changeDate": "2025-03-25T07:19:29.171Z",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc

Schema

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

Example (from schema)

{
  "instanceId": "string",
  "details": {
    "sequence": "2",
    "creationDate": "2025-03-25T07:19:29.172Z",
    "changeDate": "2025-03-25T07:19:29.172Z",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc-web+proto

Schema

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

Example (from schema)

{
  "instanceId": "string",
  "details": {
    "sequence": "2",
    "creationDate": "2025-03-25T07:19:29.172Z",
    "changeDate": "2025-03-25T07:19:29.172Z",
    "resourceOwner": "69629023906488334"
  }
}

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://$CUSTOM-DOMAIN/system/v1/instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "instanceName": "string",
  "firstOrgName": "string",
  "customDomain": "string",
  "ownerUserName": "string",
  "ownerEmail": {
    "email": "string",
    "isEmailVerified": true
  },
  "ownerProfile": {
    "firstName": "string",
    "lastName": "string",
    "preferredLanguage": "string"
  },
  "ownerPassword": {
    "password": "string",
    "passwordChangeRequired": true
  },
  "defaultLanguage": "string"
}'

Request Collapse all

Base URL

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

Body required

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

{
  "instanceName": "string",
  "firstOrgName": "string",
  "customDomain": "string",
  "ownerUserName": "string",
  "ownerEmail": {
    "email": "string",
    "isEmailVerified": true
  },
  "ownerProfile": {
    "firstName": "string",
    "lastName": "string",
    "preferredLanguage": "string"
  },
  "ownerPassword": {
    "password": "string",
    "passwordChangeRequired": true
  },
  "defaultLanguage": "string"
}

ResponseClear

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