Deprecated: Use CreateInstance instead

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

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

application/json

application/grpc

application/grpc-web+proto

Request 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

Request 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

Request 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
• 403
• 404
• default

---

A successful response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from 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

{
  "instanceId": "string",
  "details": {
    "sequence": "2",
    "creationDate": "2024-06-17T09:46:04.890Z",
    "changeDate": "2024-06-17T09:46:04.890Z",
    "resourceOwner": "69629023906488334"
  }
}

Schema

Example (from 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

{
  "instanceId": "string",
  "details": {
    "sequence": "2",
    "creationDate": "2024-06-17T09:46:04.890Z",
    "changeDate": "2024-06-17T09:46:04.890Z",
    "resourceOwner": "69629023906488334"
  }
}

Schema

Example (from 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

{
  "instanceId": "string",
  "details": {
    "sequence": "2",
    "creationDate": "2024-06-17T09:46:04.890Z",
    "changeDate": "2024-06-17T09:46:04.890Z",
    "resourceOwner": "69629023906488334"
  }
}

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

POST /instances

Request

Base URL

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

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

Body required

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

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/system/v1/instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "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"
}'

python / requests

curl -L -X POST 'https://$CUSTOM-DOMAIN/system/v1/instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "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"
}'

go / native

curl -L -X POST 'https://$CUSTOM-DOMAIN/system/v1/instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "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"
}'

nodejs / axios

curl -L -X POST 'https://$CUSTOM-DOMAIN/system/v1/instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "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"
}'

ruby / Net::HTTP

curl -L -X POST 'https://$CUSTOM-DOMAIN/system/v1/instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "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"
}'

csharp / RestSharp

curl -L -X POST 'https://$CUSTOM-DOMAIN/system/v1/instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "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"
}'

php / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/system/v1/instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "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"
}'

java / OkHttp

curl -L -X POST 'https://$CUSTOM-DOMAIN/system/v1/instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "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"
}'

powershell / RestMethod

curl -L -X POST 'https://$CUSTOM-DOMAIN/system/v1/instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "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"
}'