curl -X POST 'https://api.github.com/orgs/example-org/properties/installations' \
  -H "Authorization: Bearer $GITHUB_TOKEN" \
  -H 'Accept: application/vnd.github+json' \
  -H 'X-GitHub-Api-Version: 2026-03-10' \
  -H 'Content-Type: application/json' \
  -d '{
  "display_name": "example-display-name"
}'

# POST /orgs/{org}/properties/installations (GitHub API)
Base URL: https://api.github.com
Auth: Authorization; GitHub token; required.
Request formats: application/json.
Last verified: 2026-09-29

> Register an app installation for external custom properties

## Critical Gotchas
* GitHub recommends an `Accept: application/vnd.github+json` header and an explicit `X-GitHub-Api-Version` header.
* Fine-grained tokens only authorize repositories and permissions selected when the token is created.

## cURL
curl -X POST 'https://api.github.com/orgs/example-org/properties/installations' \
  -H "Authorization: Bearer $GITHUB_TOKEN" \
  -H 'Accept: application/vnd.github+json' \
  -H 'X-GitHub-Api-Version: 2026-03-10' \
  -H 'Content-Type: application/json' \
  -d '{
  "display_name": "example-display-name"
}'

## Parameters
| Name | In | Type | Required | Description |
| :--- | :--- | :--- | :--- | :--- |
| org | path | string | Yes | The organization name. The name is not case sensitive. |
| display_name | body | string | Yes | The display name for this app installation's external custom properties in th... |
| installation_id | body | integer | No | The unique identifier of the GitHub App installation to register for managing... |

## Response example
{"display_name":"string","installation":{"id":0}}

---
Need an API key? Get one at https://github.com/settings/tokens

POST

POST /orgs/{org}/properties/installations — GitHub API

GitHub token (required); https://api.github.com

GitHub API

Base URL: https://api.github.com
Auth: Authorization: Bearer <GITHUB_API_KEY>
Last verified: 2026-09-29 · upstream hash matched

Actions Try in browser→

Agents: curl -H "Accept: text/markdown" this URL
→ 242 tokens · Vary: Accept

Critical gotchas

GitHub recommends an Accept: application/vnd.github+json header and an explicit X-GitHub-Api-Version header.

Fine-grained tokens only authorize repositories and permissions selected when the token is created.

cURL

curl -X POST 'https://api.github.com/orgs/example-org/properties/installations' \  -H "Authorization: Bearer $GITHUB_TOKEN" \  -H 'Accept: application/vnd.github+json' \  -H 'X-GitHub-Api-Version: 2026-03-10' \  -H 'Content-Type: application/json' \  -d '{  "display_name": "example-display-name"}'

Parameters

Name	In	Type	Required	Description
org	path	string	Yes	The organization name. The name is not case sensitive.
installation_id	body	integer	No	The unique identifier of the GitHub App installation to register for managing external custom properties. When authenticating as a GitHub App installation, this defaults to the authenticated installation and can be omitted. It is required for all other callers (users and fine-grained personal access tokens).
display_name	body	string	Yes	The display name for this app installation's external custom properties in the organization. This can't be changed after the app installation is registered.

Response 200 OK

{
  "display_name": "string",
  "installation": {
    "id": 0
  }
}

Get a free GitHub API key → sponsored

Affiliate link - we may earn a commission, at no extra cost to you.