SoulFire LogoSoulFire

Create instance

Creates a new instance with the given friendly name. The instance starts in STOPPED state with default configuration.

POST
/v1/instances

Creates a new instance with the given friendly name. The instance starts in STOPPED state with default configuration.

Authorization

AuthorizationBearer <token>

Preferred API authentication. Use a JWT with the api audience.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

friendlyName?string

A human-readable name for the instance. This will be displayed in the UI and can be changed later via UpdateInstanceMeta.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://127.0.0.1:38765/v1/instances" \  -H "Content-Type: application/json" \  -d '{    "friendlyName": ""  }'
{
  "id": "string"
}
{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}
{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}
{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}

How is this page?