Virtual Machines

Virtual machine management endpoints

get

GET /api/v1/vms/os-images

Authorizations
Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/vms/os-images
GET /api/v1/vms/os-images?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*

{}
get

GET /api/v1/vms/{organization_id}

Authorizations
Path parameters
organization_idstringRequired

Path parameter: organization_id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/vms/{organization_id}
GET /api/v1/vms/{organization_id}?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*

{}
get

GET /api/v1/vms/status/{deployment_uuid}

Authorizations
Path parameters
deployment_uuidstringRequired

Path parameter: deployment_uuid

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/vms/status/{deployment_uuid}
GET /api/v1/vms/status/{deployment_uuid}?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*

{}
post

POST /api/v1/vms/create

Authorizations
Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
sluganyOptionalExample: any
lengthanyOptionalExample: any
organization_idanyOptionalExample: any
Responses
201

Created

application/json
Responseobject
post
/api/v1/vms/create
POST /api/v1/vms/create?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "slug": "any",
  "length": "any",
  "organization_id": "any"
}
{}
post

POST /api/v1/vms/{vm_id}/stop

Authorizations
Path parameters
vm_idstringRequired

Path parameter: vm_id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/vms/{vm_id}/stop
POST /api/v1/vms/{vm_id}/stop?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "organization_id": "any"
}
{}
post

POST /api/v1/vms/{vm_id}/start

Authorizations
Path parameters
vm_idstringRequired

Path parameter: vm_id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/vms/{vm_id}/start
POST /api/v1/vms/{vm_id}/start?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "organization_id": "any"
}
{}
post

POST /api/v1/vms/{vm_id}/resize

Authorizations
Path parameters
vm_idstringRequired

Path parameter: vm_id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
instance_typeanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/vms/{vm_id}/resize
POST /api/v1/vms/{vm_id}/resize?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "organization_id": "any",
  "instance_type": "any"
}
{}
post

POST /api/v1/vms/{vm_id}/resize-volume

Authorizations
Path parameters
vm_idstringRequired

Path parameter: vm_id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
volume_indexanyOptionalExample: any
new_sizeanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/vms/{vm_id}/resize-volume
POST /api/v1/vms/{vm_id}/resize-volume?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "organization_id": "any",
  "volume_index": "any",
  "new_size": "any"
}
{}
delete

DELETE /api/v1/vms/{vm_id}

Authorizations
Path parameters
vm_idstringRequired

Path parameter: vm_id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
delete
/api/v1/vms/{vm_id}
DELETE /api/v1/vms/{vm_id}?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*

{}
get

GET /api/v1/vms/{vm_id}/firewall

Authorizations
Path parameters
vm_idstringRequired

Path parameter: vm_id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/vms/{vm_id}/firewall
GET /api/v1/vms/{vm_id}/firewall?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*

{}
post

POST /api/v1/vms/{vm_id}/firewall

Authorizations
Path parameters
vm_idstringRequired

Path parameter: vm_id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
Responses
201

Created

application/json
Responseobject
post
/api/v1/vms/{vm_id}/firewall
POST /api/v1/vms/{vm_id}/firewall?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "organization_id": "any"
}
{}
put

PUT /api/v1/vms/{vm_id}/firewall/{rule_id}

Authorizations
Path parameters
vm_idstringRequired

Path parameter: vm_id

rule_idstringRequired

Path parameter: rule_id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
put
/api/v1/vms/{vm_id}/firewall/{rule_id}
PUT /api/v1/vms/{vm_id}/firewall/{rule_id}?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "organization_id": "any"
}
{}
delete

DELETE /api/v1/vms/{vm_id}/firewall/{rule_id}

Authorizations
Path parameters
vm_idstringRequired

Path parameter: vm_id

rule_idstringRequired

Path parameter: rule_id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
delete
/api/v1/vms/{vm_id}/firewall/{rule_id}
DELETE /api/v1/vms/{vm_id}/firewall/{rule_id}?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*

{}
post

POST /api/v1/vms/{vm_id}/firewall/reset

Authorizations
Path parameters
vm_idstringRequired

Path parameter: vm_id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/vms/{vm_id}/firewall/reset
POST /api/v1/vms/{vm_id}/firewall/reset?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "organization_id": "any"
}
{}
get

GET /api/v1/vms/firewall/templates

Authorizations
Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/vms/firewall/templates
GET /api/v1/vms/firewall/templates?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*

{}
PreviousAnalyticsNextCronjobs