Last updated on 23rd March 2026

View a build configuration via API

This method will return a single build configuration for your project. Build configurations define which language and tool versions are used during the build pipeline.

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

URL

/projects/<project>/build_configurations/<identifier>

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

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/build_configurations/c5d6e7f8-a9b0-1c2d-3e4f-5a6b7c8d9e0f

Example Response

{
    "identifier": "c5d6e7f8-a9b0-1c2d-3e4f-5a6b7c8d9e0f",
    "packages": {
        "node": "20",
        "ruby": "3.2",
        "python": "3.11"
    },
    "default": false,
    "servers": [
        {
            "identifier": "16d48756-20f0-1fa0-ac12-9dffb67054c0",
            "name": "Production Server",
            "protocol_type": "ssh",
            "server_path": "/var/www/app",
            "last_revision": "2aab5da1a6ae04a1e943d55213465d28056d5bc2",
            "preferred_branch": "main",
            "notify_email": false,
            "server_group_identifier": null,
            "hostname": "192.168.1.100",
            "port": 22,
            "username": "deploy",
            "use_ssh_keys": true,
            "host_key": "AAAAB3NzaC1yc2EAAAA....."
        }
    ]
}