Get Git auto-deployment settings

Returns the Git auto-deployment settings of the website: which repository and branch deploy into which directory, and whether pushes trigger a deployment.

Get Git auto-deployment settings

get

Returns the Git auto-deployment settings of the website: which repository and branch deploy into which directory, and whether pushes trigger a deployment. is_enabled false keeps the repository link but ignores pushes.

When the website has no auto-deployment configured every field is null. Save settings with Update Git auto-deployment settings.

Authorizations

AuthorizationstringRequired

API Token authentication

Path parameters

usernamestringRequiredExample: u123456789

domainstringRequired

Domain name

Example: mydomain.tld

Responses

200

Success response

application/json

Every field is null when the website has no Git auto-deployment configured.

installation_uuidstring · nullableRequired

Git installation the repository is accessed through

Example: 018f5e2a-1234-7890-abcd-1234567890ab

is_enabledboolean · nullableRequired

Whether pushes to the branch deploy automatically

Example: true

ownerstring · nullableRequired

Repository owner login

Example: octocat

repositorystring · nullableRequired

Repository name

Example: my-site

branchstring · nullableRequired

Branch that is deployed

Example: main

directorystring · nullableRequired

Subdirectory under the website document root the repository deploys into. Empty means the document root.

Example: my-api

401

Unauthenticated response

application/json

500

Error response

application/json

get/api/hosting/v1/accounts/{username}/websites/{domain}/git/auto-deployments/settings

GET /api/hosting/v1/accounts/{username}/websites/{domain}/git/auto-deployments/settings HTTP/1.1
Host: developers.hostinger.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "installation_uuid": "018f5e2a-1234-7890-abcd-1234567890ab",
  "is_enabled": true,
  "owner": "octocat",
  "repository": "my-site",
  "branch": "main",
  "directory": "my-api"
}