API V1 RESOURCES LINKS

Integration Link

Link your Scalingo application to an existing integration.

Integration link attributes

field type description
id string unique ID
app_id string application ID
auth_integration_uuid string ID of the scm integration linked for authentication
linker object description of the user that linked this repository
owner string repository owner name
repo string repository name
branch string branch used for auto deployment
scm_type string integration type
created_at date creation date of the link
updated_at date last time the link was updated
auto_deploy_enabled boolean trigger a new deployment when the linked branch is updated
deploy_review_apps_enabled boolean activation of the review apps feature
delete_on_close_enabled boolean review app: Delete the review app when the pull request is closed
hours_before_delete_on_close int review app: Time to wait before deleting a review app linked to a closed pull request (in hours)
delete_stale_enabled boolean review app: Delete the review app when there is no activity on the pull request
hours_before_delete_stale int review app: Time to wait for activity on the pull request before deleting the review app (in hours)
automatic_creation_from_forks_allowed boolean review app: Allow automatic creation of review apps from forks
last_auto_deploy_at date date of the last deployment triggered by this link

Example object:

{
  "id": "1d6e59a0-5377-11e8-90e6-0242ac110052",
  "app_id": "1d6e59a0-5377-11e8-90e6-0242ac110052",
  "auth_integration_uuid": "14235182-54f4-4951-be65-d78020615818",
  "linker": {
    "id":"us-aa263090-9a23-81f5-8c7c-5fd9a50a8fa8",
    "username":"john",
    "email":"john.doe@example.com"
  },
  "created_at": "2018-05-09T12:52:49.985+02:00",
  "updated_at": "2019-08-08T17:42:03.386+02:00",
  "owner": "my-username",
  "repo": "my-company",
  "branch": "master",
  "scm_type": "github",
  "auto_deploy_enabled": true,
  "deploy_review_apps_enabled": true,
  "delete_on_close_enabled": true,
  "hours_before_delete_on_close": 0,
  "delete_stale_enabled": false,
  "hours_before_delete_stale": 0,
  "automatic_creation_from_forks_allowed": false,
  "last_auto_deploy_at":"2019-08-30T17:42:03.385+02:00"
}

GET https://$SCALINGO_API_URL/v1/scm_repo_links

Feature: This endpoint supports pagination.

Parameters

Request example:

curl -H "Accept: application/json" -H "Content-Type: application/json" \
  -H "Authorization: Bearer $BEARER_TOKEN" \
  https://$SCALINGO_API_URL/v1/scm_repo_links

{
  "scm_repo_links": [
    {
      "id":"42d04de5-5377-11e8-90e6-0242ac110052",
      "app_id": "1d6e59a0-5377-11e8-90e6-0242ac110052",
      "auth_integration_uuid": "14235182-54f4-4951-be65-d78020615818",
      "linker": {
        "id":"us-aa263090-9a23-81f5-8c7c-5fd9a50a8fa8",
        "username":"john",
        "email":"john.doe@example.com"
      },
      "created_at":"2018-05-09T12:53:52.276+02:00",
      "updated_at":"2018-06-01T11:45:26.078+02:00",
      "owner": "my-username",
      "repo": "my-project-1",
      "branch": "master",
      "scm_type": "github",
      "auto_deploy_enabled":true,
      "github_integration_uuid":"42d04de5-5377-11e8-90e6-0242ac110052",
      "deploy_review_apps_enabled":false,
      "delete_on_close_enabled":false,
      "hours_before_delete_on_close":0,
      "delete_stale_enabled":false,
      "hours_before_delete_stale":0,
      "automatic_creation_from_forks_allowed": false,
      "last_auto_deploy_at":"2018-06-01T11:45:26.077+02:00"
    }, {
      "id":"0d7955a7-0c80-462a-84e7-bd06047103f4",
      "app_id": "3c212baa-80aa-48a4-81b1-ea8daa9b508d",
      "auth_integration_uuid": "14235182-54f4-4951-be65-d78020615818",
      "linker": {
        "id":"us-aa263090-9a23-81f5-8c7c-5fd9a50a8fa8",
        "username":"john",
        "email":"john.doe@example.com"
      },
      "created_at":"2018-05-09T12:53:52.276+02:00",
      "updated_at":"2018-06-01T11:45:26.078+02:00",
      "owner": "my-username",
      "repo": "my-project-2",
      "branch": "master",
      "scm_type": "github",
      "auto_deploy_enabled":true,
      "github_integration_uuid":"42d04de5-5377-11e8-90e6-0242ac110052",
      "deploy_review_apps_enabled":false,
      "delete_on_close_enabled":false,
      "hours_before_delete_on_close":0,
      "delete_stale_enabled":false,
      "hours_before_delete_stale":0,
      "automatic_creation_from_forks_allowed": false,
      "last_auto_deploy_at":"2018-06-01T11:45:26.077+02:00"
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "next_page": 2,
      "prev_page": null,
      "total_pages": 4,
      "total_count": 61
    }
  }
}

POST https://$SCALINGO_API_URL/v1/apps/:app_id/scm_repo_link

Parameters

  • auth_integration_uuid: Unique ID for the authentication of scm integration
  • source: URL of the SCM repository to link
  • branch: Branch used for the auto deploy feature (optional)
  • auto_deploy_enabled: Trigger a new deployment when changes are pushed to the branch specified with the branch parameter (optional)
  • deploy_review_apps_enabled: Enable the review app feature (optional)
  • delete_on_close_enabled: Delete review apps when the linked pull request is closed (optional)
  • hours_before_delete_on_close: Time to wait before deleting a review app associated to a closed pull request (optional)
  • delete_stale_enabled: Delete review apps when the linked pull request wasn’t updated recently (optional)
  • hours_before_delete_stale: Time to wait for activity before considering the pull request stale (optional)
  • automatic_creation_from_forks_allowed: Allow automatic review app creation from forks (optional, be aware of security risks)

Request example:

curl -H "Accept: application/json" -H "Content-Type: application/json" \
  -H "Authorization: Bearer $BEARER_TOKEN" \
  -X POST https://$SCALINGO_API_URL/v1/apps/example-app/scm_repo_link -d \
  '{
    "scm_repo_link" : {
      "source":"https://github.com/Scalingo/sample-go-martini",
      "branch":"master",
      "auto_deploy_enabled": true,
      "deploy_review_apps_enabled":true,
      "delete_on_close_enabled":true,
      "automatic_creation_from_forks_allowed": false,
      "hours_before_delete_on_close":0,
    }
  }'

PATCH https://$SCALINGO_API_URL/v1/apps/:app_id/scm_repo_link

Parameters

  • branch: Branch used for the auto deploy feature (optional)
  • auto_deploy_enabled: Trigger a new deployment when changes are pushed to the branch specified with the branch parameter (optional)
  • deploy_review_apps_enabled: Enable the review app feature (optional)
  • delete_on_close_enabled: Delete review apps when the linked pull request is closed (optional)
  • hours_before_delete_on_close: Time to wait before deleting a review app associated to a closed pull request (optional)
  • delete_stale_enabled: Delete review apps when the linked pull request wasn’t updated recently (optional)
  • hours_before_delete_stale: Time to wait for activity before considering the pull request stale (optional)
  • automatic_creation_from_forks_allowed: Allow automatic review app creation from forks (optional, be aware of security risks)

Request example:

curl -H "Accept: application/json" -H "Content-Type: application/json" \
  -H "Authorization: Bearer $BEARER_TOKEN" \
  -X PATCH https://$SCALINGO_API_URL/v1/apps/example-app/scm_repo_link -d \
  '{
    "scm_repo_link" : {
      "branch":"prod",
      "auto_deploy_enabled": true,
    }
  }'

Get the integration link associated to an application.

GET https:/$SCALINGO_API_URL/v1/apps/example-app/scm_repo_link

curl -H "Accept: application/json" -H "Content-Type: application/json" \
  -H "Authorization: Bearer $BEARER_TOKEN" \
  https://$SCALINGO_API_URL/v1/apps/example-app/scm_repo_link

{
  "scm_repo_link": {
    "id":"42d04de5-5377-11e8-90e6-0242ac110052",
    "app_id": "1d6e59a0-5377-11e8-90e6-0242ac110052",
    "auth_integration_uuid": "14235182-54f4-4951-be65-d78020615818",
    "linker": {
      "id":"us-aa263090-9a23-81f5-8c7c-5fd9a50a8fa8",
      "username":"john",
      "email":"john.doe@example.com"
    },
    "created_at":"2018-05-09T12:53:52.276+02:00",
    "updated_at":"2018-06-01T11:45:26.078+02:00",
    "owner": "my-username",
    "repo": "my-company",
    "branch": "master",
    "scm_type": "github",
    "auto_deploy_enabled":true,
    "github_integration_uuid":"42d04de5-5377-11e8-90e6-0242ac110052",
    "deploy_review_apps_enabled":false,
    "delete_on_close_enabled":false,
    "hours_before_delete_on_close":0,
    "delete_stale_enabled":false,
    "hours_before_delete_stale":0,
    "automatic_creation_from_forks_allowed": false,
    "last_auto_deploy_at":"2018-06-01T11:45:26.077+02:00"
  }
}

DELETE https://$SCALINGO_API_URL/v1/apps/example-app/scm_repo_link

curl -H "Accept: application/json" -H "Content-Type: application/json" \
  -H "Authorization: Bearer $BEARER_TOKEN" \
  -X DELETE https://$SCALINGO_API_URL/v1/apps/example-app/scm_repo_link

Manual Deploy

Manually deploy the given branch.

POST https://$SCALINGO_API_URL/v1/apps/example-app/scm_repo_link/manual_deploy

Parameters

  • branch: Name of the branch that will be deployed
curl -H "Accept: application/json" -H "Content-Type: application/json" \
  -H "Authorization: Bearer $BEARER_TOKEN" \
  -X POST https://$SCALINGO_API_URL/v1/apps/example-app/scm_repo_link/manual_deploy \
  -d '{
    "branch": "master"
  }'

{
  "deployment": {
    "app_id": "54100930736f7563d5030000",
    "created_at": "2014-09-10T10:49:42.390+02:00",
    "git_ref": "abcdef1234567890",
    "status": "build-error",
    "id": "123e4567-e89b-12d3-a456-426655440000",
    "pusher": {
      "email": "user@example.com",
      "id": "54100245736f7563d5000000",
      "username": "john"
    }
  }
}

Manual Review App

Manually deploy a review app of the given pull request.

POST https://$SCALINGO_API_URL/v1/apps/example-app/scm_repo_link/manual_review_app

Parameters

  • pull_request_id: ID of the pull request that will be deployed
curl -H "Accept: application/json" -H "Content-Type: application/json" \
  -H "Authorization: Bearer $BEARER_TOKEN" \
  -X POST https://$SCALINGO_API_URL/v1/apps/example-app/scm_repo_link/manual_review_app \
  -d '{
    "pull_request_id": 42
  }'

List Review Apps

List the review apps of the given application.

GET https://$SCALINGO_API_URL/v1/apps/example-app/scm_repo_link/review_apps

curl -H "Accept: application/json" -H "Content-Type: application/json" \
  -H "Authorization: Bearer $BEARER_TOKEN" \
  https://$SCALINGO_API_URL/v1/apps/example-app/scm_repo_link/review_apps

{
  "review_apps": [
    {
      "id": "1d6e59a0-5377-11e8-90e6-0242ac110052",
      "repo_link_id": "29b4c829-4150-11eb-97f7-0242ac11000e",
      "app_id": "5343eccd646173000a140000",
      "app_name": "example-app-pr238",
      "parent_app_id": "54100930736f7563d5030000",
      "parent_app_name": "example-app",
      "created_at": "2023-07-18T16:41:44Z",
      "stale_deletion_date": "2023-07-18T16:43:39.85Z",
      "on_close_deletion_date": "2135-01-17T08:41:44Z",
      "pull_request": {
        "number": 238,
        "branch_name": "Scalingo:my-fix",
        "source_repo_id": 0,
        "source_repo_name": "",
        "source_repo_url": "",
        "target_repo_id": 0,
        "title": "Sort by",
        "url": "https://api.github.com/repos/Scalingo/example-app/pulls/238",
        "html_url": "https://github.com/Scalingo/example-app/pull/238",
        "ref": "0bc7322dc67167969fdc23d217adcfe8d1d6c089",
        "base_ref": "",
        "created_at": "2023-07-18T16:41:44Z",
        "closed_at": "0001-01-01T00:00:00Z"
      },
      "last_deployment": {
        "id": "54dcdd4a73636100011a0000",
        "upstream_deployment_id": "82a3cac5-9b25-473e-b33d-6272b87e636e",
        "created_at": "2023-07-18T16:43:39.82Z",
        "status": "success",
        "git_ref": "0bc7322dc67167969fdc23d217adcfe8d1d6c089",
        "scm_link": "https://github.com/Scalingo/example-app/commit/0bc7322dc67167969fdc23d217adcfe8d1d6c089",
        "github_link": "https://github.com/Scalingo/example-app/commit/0bc7322dc67167969fdc23d217adcfe8d1d6c089",
        "pusher": {
          "username": "scalingo-platform-scm",
          "email": "deploy-scm@scalingo.com"
        }
      }
    },
    { ... }
  ]
}

List Merge / Pull Requests

List the merge / pull requests of the repository attached to the given application.

GET https://$SCALINGO_API_URL/v1/apps/example-app/scm_repo_link/pulls

curl -H "Accept: application/json" -H "Content-Type: application/json" \
  -H "Authorization: Bearer $BEARER_TOKEN" \
  https://$SCALINGO_API_URL/v1/apps/example-app/scm_repo_link/pulls

{
	"pulls": [
		{
			"id": 1431362595,
			"number": 186,
			"title": "deps: upgrade Ruby",
			"html_url": "https://github.com/Scalingo/example-app/pull/186",
			"source_repo_name": "Scalingo/example-app",
			"source_repo_html_url": "https://github.com/Scalingo/example-app",
			"opened_from_a_forked_repo": false
		},
		{
			"id": 1421681427,
			"number": 185,
			"title": "deps: upgrade Rails",
			"html_url": "https://github.com/Scalingo/example-app/pull/185",
			"source_repo_name": "Scalingo/example-app",
			"source_repo_html_url": "https://github.com/Scalingo/example-app",
			"opened_from_a_forked_repo": false
		},
		{
			"id": 1474629658,
			"number": 184,
			"title": "Bump spring from 2.1.1 to 4.1.1",
			"html_url": "https://github.com/Scalingo/example-app/pull/184",
			"source_repo_name": "Scalingo/example-app",
			"source_repo_html_url": "https://github.com/Scalingo/example-app",
			"opened_from_a_forked_repo": false
		}
	]
}