Update a global config file via API

This method allows you to update an existing global config file template.

Tip: You can explore and test this endpoint interactively using our OpenAPI documentation.

URL

/global_config_files/<identifier>

Replace <identifier> with the identifier (UUID) of the global config file.

HTTP Method

PATCH

Supported Parameters

• path - The full path to the file starting from the root of the deployed area (optional)
• body - The contents of the file, which may include %VARIABLE% placeholders (optional)
• description - A description of the config file template (optional)
• build - Whether the config file should be available during the build pipeline (optional)

Example cURL Request

curl -H "Content-type: application/json" \
-H "Accept: application/json" \
--user your-email@example.com:your-api-key \
-X PATCH \
-d '{
  "config_file": {
    "body": "production:\n  adapter: mysql2\n  host: %DB_HOST%\n  port: %DB_PORT%"
  }
}' \
https://test.deployhq.com/global_config_files/df8966fe-e161-4517-98e2-24f79102dd62

Example Response

{
  "identifier": "df8966fe-e161-4517-98e2-24f79102dd62",
  "description": "Standard database configuration",
  "path": "config/database.yml",
  "body": "production:\n  adapter: mysql2\n  host: %DB_HOST%\n  port: %DB_PORT%",
  "build": false
}