ATathenian
events
default

Notify about new deployments.

Changed on
post/events/deployments

Request

Request body

environmentstring required

Name of the environment where the deployment happened.

namestring nullable

Name of the deployment. If is not specified, we generate our own by the template <environment shortcut>-<date>-<hash of the components>. The value may not contain \n - new line character, and ' - single quote.

urlstring url

URL pointing at the internal details of the deployment.

date_startedstring date-time required

Timestamp of when the deployment procedure launched.

date_finishedstring date-time required

Timestamp of when the deployment procedure completed.

conclusion'SUCCESS' | 'FAILURE' | 'CANCELLED' required

State of the completed deployment. Case-insensitive.

labelsDeploymentLabels

Arbitrary key-value metadata that associates with the deployment.

Example request

[
  {
    "components": [
      {
        "repository": "github.com/athenianco/athenian-api",
        "reference": "v0.10.34"
      }
    ],
    "environment": "production",
    "date_finished": "2022-01-23T05:01:07.000+00:00",
    "date_started": "2022-01-23T04:56:07.000+00:00",
    "conclusion": "SUCCESS",
    "labels": {
      "helm_chart": "0.0.67"
    }
  }
]

Response

Details about the accepted deployment notifications.

Example response

{
  "deployments": [
    {
      "name": "prod-1984-05-01-ABCDEFGH",
      "resolved": true
    }
  ]
}

Changes

  • 5453f6550172Revision changes
    • info

      response schema application/json enum value removed {}

    • info

      added the required property to the response with the status

  • d08637dcd231Revision changes
    • breaking

      added the pattern ^([^'\s]| ){1,100}$ to the request property /

    • info

      the / request property's minLength was decreased from 1 to 0