Header

Edit an existing config file via API (templates)

This method allows you to edit an existing config file within a template.

URL

/templates/<permalink>/config_files/<identifier>
  • Replace <permalink> with the permalink of the template.
  • Replace <identifier> with the identifier of the config file

HTTP Method

PUT

Supported Parameters

  • path - the full path and name of the config file (required)
  • body - the body of the config file (required)
  • build - if the config file should be used in build pipeline (required - true or false)
  • all_servers - If the command should be run on all servers set to true, otherwise send an array of server_identifiers (optional)
  • server_identifiers - An array of server identifiers that the config file should be uploaded to (optional)

Example cURL Request

curl -H "Content-type: application/json" \
-H "Accept: application/json" \
--user adam@atechmedia.com:my-api-key \
-X PUT \
-d '{ \
  "config_file":{ \
    "path":"database.yml", \ 
    "body":"development:\n  adapter: mysql2", \ 
    "build":true, \ 
    "servers":[] \
  } \
}' \
https://atech.deployhq.com/templates/api-created/config_files/6908c22d-7d9e-48bf-be34-f4f327d89d61

Example Response

{
  "identifier":"6908c22d-7d9e-48bf-be34-f4f327d89d61",
  "path":"database.yml",
  "body":"development:\n  adapter: mysql2",
  "build":true,
  "servers":[]
}
Tree

Proudly powered by Katapult. Running on 100% renewable energy.