Repositories

The Repositories API allows you to access repositories connected to your account.

Get a repository

GET

/repositories/:repositoryid

Example request with cURL

curl "https://yoursubdomain.deploybot.com/api/v1/repositories/42" \
  -X GET \
  -H "X-Api-Token: api-token"

Response

id integer ID of repository
name string Name of repository
title string Name of repository in UI
color_label string Color of repository in UI
type string Type of repository (Git or SVN)
url string URL of repository
refresh_webhook_url string Webhook URL to update the repository cache from upstream
created_at string Creation timestamp
updated_at string Last update timestamp

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{ 
  "id": 1,
  "name": "example-repo",
  "title": "Example repository",
  "color_label": "label-green-blue",
  "type": "GitRepository",
  "url": "https://github.com/wildbit/pexample-repo.git",
  "refresh_webhook_url": "https://support.deploybot.com/webhook/qwertysecrethash",
  "created_at": "2015/02/18 20:55:29 +0000",
  "updated_at": "2015/02/18 20:55:29 +0000"
}

List repositories

Querystring parameters

limit Max number of repositories to return per request (default 50, max 50)
after ID of last repository returned by previous request. Used for paging results.
GET

/repositories

Example request with cURL

curl "https://yoursubdomain.deploybot.com/api/v1/repositories?limit=2&after=42" \
  -X GET \
  -H "X-Api-Token: api-token"

Response

meta object
meta/next integer Next page’s after parameter’s value
meta/next_uri string Next page’s URI when the query results do not fit on a single page
meta/total integer Total number of matching repositories
entries array List of repositories matching the query
entries/id integer ID of repository
entries/name string Name of repository
entries/title string Name of repository in UI
entries/color_label string Color of repository in UI
entries/type string Type of repository (Git or SVN)
entries/url string URL of repository
entries/refresh_webhook_url string Webhook URL to update the repository cache from upstream
entries/created_at string Creation timestamp
entries/updated_at string Last update timestamp

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{ 
  "meta": {
    "next": 45,
    "next_uri": "/repositories?after=45&limit=2",
    "total": 3
  },
  "entries": [
    {
      "id": 43,
      "name": "example-repo",
      "title": "Example repository",
      "color_label": "label-green-blue",
      "type": "GitRepository",
      "url": "https://github.com/wildbit/pexample-repo.git",
      "refresh_webhook_url": "https://support.deploybot.com/webhook/qwertysecrethash",
      "created_at": "2015/02/19 21:53:42 +0000",
      "updated_at": "2015/03/01 20:02:49 +0000"
    }
  ]
}