DocsToolsDevStats API

Deploy API

Base URL:https://service.devstats.com/api/v1

Authorization

Bearer token required. Include in the header:

Authorization: Bearer <token>

GET/deploys

List Deploys

Retrieves a list of deploys.

Query Parameters

Name	Type	In	Required	Description
`per_page`	number	query	No	Min: 1
`page`	number	query	No	Min: 1
`repository`	string	query	No	Min length: 1Max length: 255

GET /api/v1/deploys HTTP/1.1
Host: service.devstats.com
Authorization: Bearer <token>
Accept: application/json

Responses

POST/deploys

Create Deploy

Creates a new deployment for the repository.

Request Body

Name	Type	In	Required	Description
`repository`	string	body	Yes	The full name of the repository.
`deployed_at`	string	body	Yes	The deployment date in the ISO 8601 format.
`commit_sha`	string	body	No	The commit SHA of the deployment.

POST /api/v1/deploys HTTP/1.1
Host: service.devstats.com
Authorization: Bearer <token>
Accept: application/json
Content-Type: application/json

{
  "repository": "organization/repository",
  "deployed_at": "2024-07-20T15:30:00-03:00",
  "commit_sha": "1234567890abcdef1234567890abcdef12345678"
}

Responses

DELETE/deploys/{deploy}

Delete Deploy

Deletes an existing deploy.

Path Parameters

Name	Type	In	Required	Description
`deploy`	string	path	Yes	The deploy UUID

DELETE /api/v1/deploys/<deploy> HTTP/1.1
Host: service.devstats.com
Authorization: Bearer <token>
Accept: application/json

Responses

PATCH/deploys/{deploy}

Update Deploy

Updates an existing deploy.

Path Parameters

Name	Type	In	Required	Description
`deploy`	string	path	Yes	The deploy UUID

Request Body

Name	Type	In	Required	Description
`deployed_at`	string	body	No	The deployment date in the ISO 8601 format.
`commit_sha`	string	body	No	The commit SHA of the deployment.

PATCH /api/v1/deploys/<deploy> HTTP/1.1
Host: service.devstats.com
Authorization: Bearer <token>
Accept: application/json
Content-Type: application/json

{
  "deployed_at": "2024-07-20T15:30:00-03:00",
  "commit_sha": "1234567890abcdef1234567890abcdef12345678"
}

Responses