Last updated on 1st April 2026

Listing all config files via API

This method will return a list of all config files which are configured in a specific project.

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

URL

/projects/<project>/config_files

Replace <project> with either the permalink or identifier of the project.

HTTP Method

GET

Supported Parameters

None

Example cURL Request

curl -H "Content-type: application/json" \
-H "Accept: application/json" \
--user adam@atechmedia.com:my-api-key \
https://test.deployhq.com/projects/project/config_files

Example JSON

[
  {
    "identifier": "19c8d0df-0ab9-2f1f-1a4b-5aec4c37c7b7",
    "description": "Database configuration",
    "path": "config/database.yml",
    "body": "**content**",
    "build": false,
    "servers": [
      {
        "id": 12345,
        "identifier": "16d48756-20f0-1fa0-ac12-9dffb67054c0",
        "name": "Development Server",
        "protocol_type": "ssh"
      }
    ],
    "url": "https://test.deployhq.com/projects/my-project/config_files/19c8d0df-0ab9-2f1f-1a4b-5aec4c37c7b7"
  }
]