Creates a new instance with all needed setup data This might take some time
POST/instances/_create
Creates a new instance with all needed setup data This might take some time
Request​
- application/json
- application/grpc
- application/grpc-web+proto
Body
required
human
object
email
object
profile
object
password
object
machine
object
personalAccessToken
object
The date the token will expire and no logins will be possible
machineKey
object
Possible values: [KEY_TYPE_UNSPECIFIED
, KEY_TYPE_JSON
]
Default value: KEY_TYPE_UNSPECIFIED
The date the key will expire and no logins will be possible
Body
required
human
object
email
object
profile
object
password
object
machine
object
personalAccessToken
object
The date the token will expire and no logins will be possible
machineKey
object
Possible values: [KEY_TYPE_UNSPECIFIED
, KEY_TYPE_JSON
]
Default value: KEY_TYPE_UNSPECIFIED
The date the key will expire and no logins will be possible
Body
required
human
object
email
object
profile
object
password
object
machine
object
personalAccessToken
object
The date the token will expire and no logins will be possible
machineKey
object
Possible values: [KEY_TYPE_UNSPECIFIED
, KEY_TYPE_JSON
]
Default value: KEY_TYPE_UNSPECIFIED
The date the key will expire and no logins will be possible
Responses​
- 200
- 403
- 404
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
"instanceId": "string",
"details": {
"sequence": "2",
"creationDate": "2024-11-22T09:27:08.851Z",
"changeDate": "2024-11-22T09:27:08.851Z",
"resourceOwner": "69629023906488334"
},
"pat": "string",
"machineKey": "string"
}
- Schema
- Example (from schema)
Schema
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
"instanceId": "string",
"details": {
"sequence": "2",
"creationDate": "2024-11-22T09:27:08.851Z",
"changeDate": "2024-11-22T09:27:08.851Z",
"resourceOwner": "69629023906488334"
},
"pat": "string",
"machineKey": "string"
}
- Schema
- Example (from schema)
Schema
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
"instanceId": "string",
"details": {
"sequence": "2",
"creationDate": "2024-11-22T09:27:08.851Z",
"changeDate": "2024-11-22T09:27:08.851Z",
"resourceOwner": "69629023906488334"
},
"pat": "string",
"machineKey": "string"
}
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
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"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
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}