/

/Port Layer API

APIs
Generators
Stacks
Projects

Docs
History
Schema
Sources

v1

latestSwagger 2.02026-07-17625075.9 KB

misc

ping the portlayer server

Pings the server to see if it's running

get/_ping

Response

OK

All 62 operations

get ping the portlayer server
get /vch/info
get /kv/{key}
put /kv/{key}
delete /kv/{key}
get Export tar archive from supplied target
post Import tar stream to supplied target
head /archive
post creates an image store
get Retrieve a list of images in an image store
post Creates a new image layer
get Inspect an image
post /storage/{store_name}/info/{id}
delete Delete an image
get Get images storage usage
get Get an image as a tar file
get /storage/volumestores
get /storage/volumes
post Creates a Volume with metadata that is provided from the personality
get /storage/volumes/{name}
post /storage/volumes/{name}
delete Remove a volume
get /scopes
post Create a new scope
get /scopes/{idName}
delete /scopes/{idName}
post /scopes/{scope}/containers
delete /scopes/{scope}/containers/{handle}
get /scopes/containers/{handleOrId}
post /scopes/containers/{handle}/binding
delete /scopes/containers/{handle}/binding
get Gets portlayer events
post Initiates a container create operation
get /containers/info/{id}
get /containers/list
get /containers/{id}
delete /containers/{id}
put /containers/{handle}
get /containers/{handle}/state
put /containers/{handle}/state
get Initiates a task wait operation
get Initiates a task inspect operation
post Initiates a task join operation
delete Initiates a task remove operation
post Activate an existing task
delete Deactivate an existing task
patch /containers/{handle}/name
post Signal a running container
get Gets the container stats
get Gets the container logs
post Add logging capability
post Enable/bind/activate the VirtualDevice
delete Disable/unbind/deactivate the VirtualDevice
post Add interaction capability
post Enable/bind/activate the VirtualDevice
delete Disable/unbind/deactivate the VirtualDevice
get /containers/{id}/wait
post Resize tty session
post Set stdin
delete Close stdin
get Get stdout
get Get stderr