Virtual Machines
Virtual machine management endpoints
GET /api/v1/vms/os-images
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304OK
Bad Request
Unauthorized
Forbidden
Not Found
GET /api/v1/vms/os-images HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*
{}GET /api/v1/vms/{organization_id}
Path parameter: organization_id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304OK
Bad Request
Unauthorized
Forbidden
Not Found
GET /api/v1/vms/{organization_id} HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*
{}GET /api/v1/vms/status/{deployment_uuid}
Path parameter: deployment_uuid
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304OK
Bad Request
Unauthorized
Forbidden
Not Found
GET /api/v1/vms/status/{deployment_uuid} HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*
{}POST /api/v1/vms/create
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304anyanyanyCreated
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
POST /api/v1/vms/create 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 /api/v1/vms/{vm_id}/stop
Path parameter: vm_id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304anyOK
Bad Request
Unauthorized
Forbidden
Not Found
POST /api/v1/vms/{vm_id}/stop HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"organization_id": "any"
}{}POST /api/v1/vms/{vm_id}/start
Path parameter: vm_id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304anyOK
Bad Request
Unauthorized
Forbidden
Not Found
POST /api/v1/vms/{vm_id}/start HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"organization_id": "any"
}{}POST /api/v1/vms/{vm_id}/resize
Path parameter: vm_id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304anyanyOK
Bad Request
Unauthorized
Forbidden
Not Found
POST /api/v1/vms/{vm_id}/resize 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 /api/v1/vms/{vm_id}/resize-volume
Path parameter: vm_id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304anyanyanyOK
Bad Request
Unauthorized
Forbidden
Not Found
POST /api/v1/vms/{vm_id}/resize-volume 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 /api/v1/vms/{vm_id}
Path parameter: vm_id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304OK
Bad Request
Unauthorized
Forbidden
Not Found
DELETE /api/v1/vms/{vm_id} HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*
{}GET /api/v1/vms/{vm_id}/firewall
Path parameter: vm_id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304OK
Bad Request
Unauthorized
Forbidden
Not Found
GET /api/v1/vms/{vm_id}/firewall HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*
{}POST /api/v1/vms/{vm_id}/firewall
Path parameter: vm_id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304anyCreated
Bad Request
Unauthorized
Forbidden
Not Found
POST /api/v1/vms/{vm_id}/firewall HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"organization_id": "any"
}{}PUT /api/v1/vms/{vm_id}/firewall/{rule_id}
Path parameter: vm_id
Path parameter: rule_id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304anyOK
Bad Request
Unauthorized
Forbidden
Not Found
PUT /api/v1/vms/{vm_id}/firewall/{rule_id} HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"organization_id": "any"
}{}DELETE /api/v1/vms/{vm_id}/firewall/{rule_id}
Path parameter: vm_id
Path parameter: rule_id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304OK
Bad Request
Unauthorized
Forbidden
Not Found
DELETE /api/v1/vms/{vm_id}/firewall/{rule_id} HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*
{}POST /api/v1/vms/{vm_id}/firewall/reset
Path parameter: vm_id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304anyOK
Bad Request
Unauthorized
Forbidden
Not Found
POST /api/v1/vms/{vm_id}/firewall/reset HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"organization_id": "any"
}{}GET /api/v1/vms/firewall/templates
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304OK
Bad Request
Unauthorized
Forbidden
Not Found
GET /api/v1/vms/firewall/templates HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*
{}