API Reference

The Airlock API is used for submitting events to the Airlock collector as well as exporting and managing data. The reporting and web APIs are individually versioned. This document refers to the web APIs only. For information about the reporting API see SDK Development.

Versioning

The current version of the web API is known as v0 and is considered to be in a draft phase. While we don’t expect public endpoints to change greatly, keep in mind that the API is still under development.

Reference

  • Requests
  • Authentication
  • Permissions
  • Pagination

Endpoints

A full list of the currently supported API endpoints:

  • Issues
    • List a Project’s Issues
    • Retrieve an Issue
    • Update an Issue
    • Remove an Issue
    • List an Issue’s Events
    • List an Issue’s Hashes
    • Retrieve an Issue Tag’s Details
    • List an Issue Tag’s Values
    • Retrieve the Newest Event for an Issue
    • Retrieve the Oldest Event for an Issue
    • Bulk Mutate a List of Issues
    • Bulk Remove a List of Issues
  • Events
    • List a Project’s Events
    • Resolve an Event ID
    • Resolve a Short ID
    • Retrieve an Event for a Project
    • Retrieve Event Counts for a Project
    • Retrieve Event Counts for a Team
  • User Feedback
    • List a Project’s User Feedback
    • Submit User Feedback
  • Releases
    • List Releases
    • Retrieve a Release
    • Create a New Release
    • Update a Release
    • Delete a Release
    • List issues to be resolved in a particular release
    • Deploys
      • List a Release’s Deploys
      • Create a Deploy
    • Files
      • List Files
      • Retrieve a File
      • Upload a New File
      • Update a File
      • Delete a File
    • Commits
      • List a Release’s Commits
      • Retrieve Files Changed in a Release’s Commits
  • Organizations
    • Create a New Organization
    • Delete an Organization
    • List a Repository’s Commits
    • List an Organization’s Projects
    • List an Organization’s Repositories
    • List your Organizations
    • Retrieve an Organization
    • Retrieve Event Counts for an Organization
    • Update an Organization
  • Projects
    • List your Projects
    • Create a New Project
    • Retrieve a Project
    • Update a Project
    • Delete a Project
    • List a Project’s Users
    • List a Tag’s Values
    • List a Team’s Projects
    • Client Keys
      • List a Project’s Client Keys
      • Create a new Client Key
      • Update a Client Key
      • Delete a Client Key
    • Service Hooks (Beta)
      • List a Project’s Service Hooks
      • Retrieve a Service Hook
      • Create a new Service Hook
      • Update a Service Hook
      • Remove a Service Hook
  • Teams
    • List an Organization’s Teams
    • Create a new Team
    • Retrieve a Team
    • Update a Team
    • Delete a Team