Files
Julien Lengrand-Lambert 9db8c25cdc Adding flyio APIs
2024-03-07 16:17:20 +01:00

182 lines
4.5 KiB
HTTP

## MachinesApi
### Cordon Machine
## Cordon Machine
POST https://api.machines.dev/v1/apps/{{app_name}}/machines/{{machine_id}}/cordon
Authorization: Bearer {{bearerToken}}
### Create Machine
## Create Machine
POST https://api.machines.dev/v1/apps/{{app_name}}/machines
Content-Type: application/json
Accept: application/json
Authorization: Bearer {{bearerToken}}
{
"config": "<string>",
"lease_ttl": "<number>",
"lsvd": "<string>",
"name": "<string>",
"region": "<string>",
"skip_launch": "<string>",
"skip_service_registration": "<string>"
}
### Create Lease
## Create Lease
POST https://api.machines.dev/v1/apps/{{app_name}}/machines/{{machine_id}}/lease
Content-Type: application/json
Accept: application/json
Authorization: Bearer {{bearerToken}}
{
"description": "<string>",
"ttl": "<number>"
}
### Destroy Machine
## Destroy Machine
DELETE https://api.machines.dev/v1/apps/{{app_name}}/machines/{{machine_id}}
Authorization: Bearer {{bearerToken}}
### Delete Metadata
## Delete Metadata
DELETE https://api.machines.dev/v1/apps/{{app_name}}/machines/{{machine_id}}/metadata/{{key}}
Authorization: Bearer {{bearerToken}}
### Execute Command
## Execute Command
POST https://api.machines.dev/v1/apps/{{app_name}}/machines/{{machine_id}}/exec
Content-Type: application/json
Accept: application/octet-stream
Accept: application/json
Authorization: Bearer {{bearerToken}}
{
"cmd": "<string>",
"command": "<string>",
"timeout": "<number>"
}
### List Machines
## List Machines
GET https://api.machines.dev/v1/apps/{{app_name}}/machines
Accept: application/json
Authorization: Bearer {{bearerToken}}
### List Events
## List Events
GET https://api.machines.dev/v1/apps/{{app_name}}/machines/{{machine_id}}/events
Accept: application/json
Authorization: Bearer {{bearerToken}}
### List Processes
## List Processes
GET https://api.machines.dev/v1/apps/{{app_name}}/machines/{{machine_id}}/ps
Accept: application/json
Authorization: Bearer {{bearerToken}}
### List Versions
## List Versions
GET https://api.machines.dev/v1/apps/{{app_name}}/machines/{{machine_id}}/versions
Accept: application/json
Authorization: Bearer {{bearerToken}}
### Release Lease
## Release Lease
DELETE https://api.machines.dev/v1/apps/{{app_name}}/machines/{{machine_id}}/lease
Authorization: Bearer {{bearerToken}}
### Restart Machine
## Restart Machine
POST https://api.machines.dev/v1/apps/{{app_name}}/machines/{{machine_id}}/restart
Accept: application/json
Authorization: Bearer {{bearerToken}}
### Get Machine
## Get Machine
GET https://api.machines.dev/v1/apps/{{app_name}}/machines/{{machine_id}}
Accept: application/json
Authorization: Bearer {{bearerToken}}
### Get Lease
## Get Lease
GET https://api.machines.dev/v1/apps/{{app_name}}/machines/{{machine_id}}/lease
Accept: application/json
Authorization: Bearer {{bearerToken}}
### Get Metadata
## Get Metadata
GET https://api.machines.dev/v1/apps/{{app_name}}/machines/{{machine_id}}/metadata
Accept: application/json
Authorization: Bearer {{bearerToken}}
### Signal Machine
## Signal Machine
POST https://api.machines.dev/v1/apps/{{app_name}}/machines/{{machine_id}}/signal
Content-Type: application/json
Accept: application/json
Authorization: Bearer {{bearerToken}}
{
"signal": "<string>"
}
### Start Machine
## Start Machine
POST https://api.machines.dev/v1/apps/{{app_name}}/machines/{{machine_id}}/start
Authorization: Bearer {{bearerToken}}
### Stop Machine
## Stop Machine
POST https://api.machines.dev/v1/apps/{{app_name}}/machines/{{machine_id}}/stop
Content-Type: application/json
Accept: application/json
Authorization: Bearer {{bearerToken}}
{
"signal": "<string>",
"timeout": "<string>"
}
### Uncordon Machine
## Uncordon Machine
POST https://api.machines.dev/v1/apps/{{app_name}}/machines/{{machine_id}}/uncordon
Authorization: Bearer {{bearerToken}}
### Update Machine
## Update Machine
POST https://api.machines.dev/v1/apps/{{app_name}}/machines/{{machine_id}}
Content-Type: application/json
Accept: application/json
Authorization: Bearer {{bearerToken}}
{
"config": "<string>",
"current_version": "<string>",
"lease_ttl": "<number>",
"lsvd": "<string>",
"name": "<string>",
"region": "<string>",
"skip_launch": "<string>",
"skip_service_registration": "<string>"
}
### Update Metadata
## Update Metadata
POST https://api.machines.dev/v1/apps/{{app_name}}/machines/{{machine_id}}/metadata/{{key}}
Accept: application/json
Authorization: Bearer {{bearerToken}}
### Wait for State
## Wait for State
GET https://api.machines.dev/v1/apps/{{app_name}}/machines/{{machine_id}}/wait
Accept: application/json
Authorization: Bearer {{bearerToken}}