APapify
Users

Register deployment key

Changed on

Registers the Actor's deployment key (a read-only SSH key generated for every Actor) on a repository through a connected git account, so that Apify can clone the repository when building the Actor.

You need write access to the Actor. The repository's host must match the provider of the connected account. If the key is already registered on the repository, nothing changes. On GitHub, registering the key on another repository removes it from the previously linked one.

post/v2/integrations/git/{providerId}/register-deployment-key

Request

  • Base URL
    https://api.apify.com
  • Auth
    • HTTP bearer
    • or API key in query parameter token

Path parameters

providerIdstring required
Example:github-app

The connected git account to use: github-app for the GitHub App, or the ID of a connected GitLab or Bitbucket integration, as returned by Get git provider integrations.

Request body

actorIdstring required

ID or username~name of the Actor whose deployment key to register.

repoNamestring required

URL of the repository to register the key on. Its host must match the provider.

Example request

{
  "actorId": "janedoe~my-actor",
  "repoName": "https://github.com/janedoe/my-actor"
}

Response

Example response

{
  "data": {
    "repoName": "https://github.com/janedoe/my-actor"
  }
}

Changes

  • ec76185eb934Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • e52dd2239ceeRevision changes
    • info

      endpoint added