Check running a storage on several servers

POST

/api/managed-storage/{id}/availability/preflight

curl --request POST \
  --url https://opfield.example.com/api/managed-storage/550e8400-e29b-41d4-a716-446655440000/availability/preflight \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "nodeIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "witness": { "relayIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "nodeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "durability": "synchronous", "manual": true }'

• Your Opfield instance

The preflight of turning availability on with these extra servers (the storage’s own server is always a member). Needs storage:edit. Needs the current plan with multi-node availability (Business).

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

Request Body^required

JSON request body

Media typeapplication/json

object

nodeIds

required

Array<string>

>= 1 items <= 5 items

witness

object

relayIds

Array<string>

<= 5 items

nodeId

string format: uuid

durability

string | null

Allowed values: synchronous asynchronous

manual

boolean

Responses

200

Successful response

Media typeapplication/json

object

data

required

object

mode

required

Automatic | manual

string

voters

required

Array<string>

witnesses

required

Array<object>

object

kind

required

Relay | node

string

id

required

string

name

required

string

candidates

required

Every host that may be a witness for these servers, not only the ones picked

Array<object>

object

kind

required

string

id

required

string

name

required

string

durabilityFixed

required

The durability the engine always uses, or null

string | null

rttP50Ms

required

number | null

defaultDurability

required

Synchronous | asynchronous

string

durability

required

Synchronous | asynchronous

string

lossWindowText

required

string

restartNeeded

required

boolean

policyLeaseHours

required

number | null

missingForAutomatic

required

string | null

blockers

required

Array<object>

object

code

required

string

message

required

string

warnings

required

Array<string>

Example

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example resource",
    "createdAt": "2024-01-01T12:00:00.000Z",
    "updatedAt": "2024-01-01T12:30:00.000Z"
  }
}

400

Bad request

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}