APIs

Authentication

1. In the Multitudes app, go to Settings > Integrations and click on the “Connect” button in the Deployments API card.

   

2. On the resulting modal, click “Generate Token”.

   

3. After the token has been generated, click "Copy Token" and use it in your API calls (see Step 2 below). You will only see this token once!

   

When you close out of the modal, the Deployments API card will now have a “Configure” button instead of “Connect” (see screenshot at left below). Clicking it will give you options to revoke your token or regenerate a new one, should you need it (see screenshot at right below).

POST a deployment

To tell us about a deployment, make an HTTP POST request to our endpoint with the generated authentication token in the header and required parameters. Note that we include all data POSTed in our metric calculations, so you may want to send us only deployments in your production environment, see more details here.

Path

{% code-block language="shell" %}
https://api.developer.multitudes.co/deployments
{% end-code-block %}

Body parameters

• commitSha string or string[] Required
  
  The SHA-1 value(s) of the commit(s) being deployed. Each value should have a minimum of 7 characters. While this is likely fine for most organizations, you may wish to send us a longer SHA if you’d like more assurance that they will be matched to the correct commit and PR data (see here for more information on the uniqueness of short SHA-1 values).
  
  Commits should all be from the same repository. This will determine how the our repositories filter interacts with charts like Deployment Frequency. If there are commits from different repos in the commit_sha field, we will assume the repository of the first commit in the list.
  
  Commits that are authored by users who are not a Contributor in Multitudes will be filtered out of results. If a deployment has no commits authored by Multitudes contributors, the whole deployment will be filtered out of results as we won't be able to attribute it to a Multitudes contributor nor their team.
  If a deployment only has commits authored by bots, these will be included in the grey Organization line only.
• environmentName string Required
  
  ‍The environment that this is deploying to. We recommend only sending us deployments to your main production environment for an accurate indicator of Deployment Frequency. We don't filter on environmentName.
  ‍
  If you send us deployments to  multiple environments for the same commits, we will take the time of the latest deploy to calculate the Deploy Time (and therefore Change Lead Time) of a matched PR. This is because we assume the PR hasn't been fully released until it has been deployed to all environments.
  
  If you send us deployments with the same commits and environment name, we will dedupe by taking the latest received deployment.

• deployedAt UTC datetime in ISO8601 format
  The time of the deployment.
  Default: the timestamp that the POST request was received by our API
• title string
  ‍A title to give your deployment for easy identification on our drilldown tables.
  Default: the commit message of the matched commit with the most recent commit timestamp
• tags string
  A custom field for you to add labels in a comma separated string (e.g., is_fix, is_failure, sev1, product_launch). In the future, we would like to support filtering on these labels.
  Default: none

Responses

Below is formatted as code, response text, description

• 201 , Created successfully , Deploy registered successfully.
• 400 , Invalid request - {reason} , The data is not in the expected format, the reason will explain which field is the issue
• 401 , Unauthorized , API key not valid
• 403 , Forbidden , API key does not have the correct scopes or organisation for this request or has been revoked
• 500 , Internal server error. Please contact support@multitudes.co for more information , An unknown error has occurred, please contact support with the returned request ID for us to investigate.

Examples

curl

--fail-with-body flag to ensure cURL will exit with code 22 on an HTTP failure status code (>=400). Otherwise, you can look for a non-20x status code to detect a failure.

With a single commit SHA:
{% code-block language="shell" %}
curl --request POST \          
  --fail-with-body \  
  --url "https://api.developer.multitudes.co/deployments" \
  --header "Content-Type: application/json" \
  --header "Authorization: $MULTITUDES_ACCESS_TOKEN" \
  --data '{"commitSha": "$COMMIT_SHA", "environmentName":"$ENVIRONMENT"}'
{% end-code-block %}
With a list of commit SHAs:
{% code-block language="shell" %}
curl --request POST \          
  --fail-with-body \  
  --url "https://api.developer.multitudes.co/deployments" \
  --header "Content-Type: application/json" \
  --header "Authorization: $MULTITUDES_ACCESS_TOKEN" \
  --data '{
   "commitSha": [
       "8750d79cce5f2d137c3f4a34cdd4c9da76c26cfb",
       "561b41361698b579e40f0f9a68491a0e64f48849"
   ],
   "environmentName": "test"
}'
{% end-code-block %}

GitHub Actions

Example with a single commit SHA:
{% code-block language="shell" %}
jobs:
  log-deployment:
    runs-on: ubuntu-latest    
    needs: [ <DEPLOYMENT_JOB> ]    
    environment: ${{ inputs.environment }}    
    steps:          
      - run: |          
          curl --request POST \         
            --fail-with-body \          
            --url "https://api.developer.multitudes.co/deployments" \          
            --header "Content-Type: application/json" \          
            --header "Authorization: ${{ secrets.MULTITUDES_ACCESS_TOKEN }}" \          
            --data '{"commitSha": "${{github.sha}}","environmentName": "${{inputs.environment}}"}'
{% end-code-block %}