Skip to main content
POST
/
instances
/
{instanceId}
/
images
/
{type}
Upload an instance image
curl --request POST \
  --url https://api.altostrat.io/instances/{instanceId}/images/{type} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file'
{
  "type": "invalid_request_error",
  "code": "parameter_missing",
  "message": "The 'name' parameter is required for this request.",
  "doc_url": "https://docs.altostrat.io/errors/parameter_missing"
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Provide your token in the 'Authorization' header. Example: Authorization: Bearer <YOUR_TOKEN>

Path Parameters

​
instanceId
string<uuid>
required

The unique identifier for the captive portal instance.

Example:

"9a7f1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c"

​
type
enum<string>
required

The type of image to upload.

Available options:
logo,
icon
Example:

"logo"

Body

multipart/form-data
​
file
file

The image file to upload. Logos should be at least 120x80px. Icons must be square and at least 32x32px.

Response

The image was uploaded and accepted for processing.