API Reference - Nimbus

This page is rendered entirely from the openapi.yaml file sitting next to it in this page bundle — no separate Swagger UI build step, no JS widget to keep updated, just Hugo parsing the spec at build time.

Deploys API

v1.0

Trigger and inspect deployments for a service.

Base URL: https://api.example.com/v1

get /services/{serviceId}/deploys List recent deploys

Returns the most recent deploys for a service, newest first.

Parameters

Name	In	Type	Description
serviceId*	path	string	The service identifier.
limit	query	integer	Max number of results to return (default 20).

Responses

200 — A list of deploys.

array of object

404 — Service not found.

post /services/{serviceId}/deploys Trigger a new deploy

Starts a new deploy of the given image to the service.

Parameters

Name	In	Type	Description
serviceId*	path	string	The service identifier.

Request Body

application/json

Field	Type	Description
image*	string	Container image, including tag.
replicas	integer	Desired replica count. Defaults to current value.

Responses

202 — Deploy accepted and queued.

Field	Type	Description
id	string	Unique deploy identifier.
image	string	Container image that was deployed.
startedAt	string	ISO-8601 timestamp.
status	string	One of pending, running, succeeded, failed.

400 — Invalid request body.

get /services/{serviceId}/deploys/{deployId} Get deploy status

Parameters

Name	In	Type	Description
serviceId*	path	string	The service identifier.
deployId*	path	string	The deploy identifier.

Responses

200 — The deploy.

Field	Type	Description
id	string	Unique deploy identifier.
image	string	Container image that was deployed.
startedAt	string	ISO-8601 timestamp.
status	string	One of pending, running, succeeded, failed.