SoulFire LogoSoulFire

Add instance proxy

Adds a proxy to the instance.

POST
/v1/instances/{id}/proxies

Adds a proxy to the instance.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

The unique identifier (UUID) of the instance.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request to add a single proxy to an instance.

proxy*

The proxy configuration to add.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/proxies" \  -H "Content-Type: application/json" \  -d '{    "proxy": {      "type": "HTTP",      "address": "string"    }  }'
{}

How is this page?

Batch add instance proxies POST

Adds multiple proxies to the instance in a single operation. More efficient than multiple AddInstanceProxy calls.

List instances GET

Lists all instances the current user has permission to view. Only instances where the user has READ_INSTANCE permission are returned. Returns summary information for each instance.