API References

The Humanitec API  allows you to automate and integrate Humanitec into your developer and operational workflows. The API is a REST based API.

Content Types #

All of the Humanitec API only accepts content types of application/json and will always return valid application/json or an empty response, unless explicitly mentioned otherwise.

Usage #

You may use either the humctl CLI or any other HTTP client like curl to access the API.

It is usually more convenient to use a humctl CLI command, e.g. humctl create app, to manage Orchestrator objects. Explore the CLI online help to see if a command is available for your use case, and only fall back to an API call otherwise.

# Make API requests using the CLI
humctl api get /orgs/my-org/apps
humctl api post /orgs/my-org/apps \
  -d '
{
  "id": "my-app",
  "name": "My app"
}'

# Make API requests using curl
curl https://api.humanitec.io/orgs/my-org/apps \
  -H "Authorization: Bearer ${HUMANITEC_TOKEN}"
curl https://api.humanitec.io/orgs/my-org/apps \
  -X POST \
  -H "Authorization: Bearer ${HUMANITEC_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '
{
  "id": "my-app",
  "name": "My app"
}'

Almost all requests made to the Humanitec API require authentication. See Authentication for details.