Benutzerdefinierte Eigenschaften - GitHub Enterprise Server 3.21 Docs

Get custom properties for an enterprise

Gets all custom properties defined for an enterprise. Enterprise members can read these properties.

Fine-grained access tokens for "Get custom properties for an enterprise"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Custom properties" enterprise permissions (read)

Parameter für "Get custom properties for an enterprise"

Header
Name, Typ, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, Typ, BESCHREIBUNG
`enterprise` string Erforderlich The slug version of the enterprise name.

HTTP response status codes for "Get custom properties for an enterprise"

Status code	BESCHREIBUNG
`200`	OK
`403`	Forbidden
`404`	Resource not found

Code samples for "Get custom properties for an enterprise"

Request example

get/enterprises/{enterprise}/properties/schema

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/properties/schema

Response

Status: 200

[
  {
    "property_name": "environment",
    "url": "https://HOSTNAME/orgs/github/properties/schema/environment",
    "source_type": "organization",
    "value_type": "single_select",
    "required": true,
    "default_value": "production",
    "description": "Prod or dev environment",
    "allowed_values": [
      "production",
      "development"
    ],
    "values_editable_by": "org_actors",
    "require_explicit_values": true
  },
  {
    "property_name": "service",
    "url": "https://HOSTNAME/orgs/github/properties/schema/service",
    "source_type": "organization",
    "value_type": "string"
  },
  {
    "property_name": "team",
    "url": "https://HOSTNAME/orgs/github/properties/schema/team",
    "source_type": "organization",
    "value_type": "string",
    "description": "Team owning the repository"
  }
]

Create or update custom properties for an enterprise

Creates new or updates existing custom properties defined for an enterprise in a batch.

If the property already exists, the existing property will be replaced with the new values. Missing optional values will fall back to default values, previous values will be overwritten. E.g. if a property exists with values_editable_by: org_and_repo_actors and it's updated without specifying values_editable_by, it will be updated to default value org_actors.

To use this endpoint, the authenticated user must be an administrator for the enterprise.

Fine-grained access tokens for "Create or update custom properties for an enterprise"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Custom properties" enterprise permissions (write)

Parameter für "Create or update custom properties for an enterprise"

Header
Name, Typ, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, Typ, BESCHREIBUNG
`enterprise` string Erforderlich The slug version of the enterprise name.

Name, Typ, BESCHREIBUNG

properties array of objects Erforderlich

The array of custom properties to create or update.

Properties of properties

Name, Typ, BESCHREIBUNG
`property_name` string Erforderlich The name of the property
`url` string The URL that can be used to fetch, update, or delete info about this property via the API.
`source_type` string The source type of the property Kann eine der folgenden sein: `organization`, `enterprise`
`value_type` string Erforderlich The type of the value for the property Kann eine der folgenden sein: `string`, `single_select`, `multi_select`, `true_false`, `url`
`required` boolean Whether the property is required.
`default_value` null or string or array Default value of the property
`description` string or null Short description of the property
`allowed_values` array of strings or null An ordered list of the allowed values of the property. The property can have up to 200 allowed values.
`values_editable_by` string or null Who can edit the values of the property Kann eine der folgenden sein: `org_actors`, `org_and_repo_actors`, `null`
`require_explicit_values` boolean Whether setting properties values is mandatory

HTTP response status codes for "Create or update custom properties for an enterprise"

Status code	BESCHREIBUNG
`200`	OK
`403`	Forbidden
`404`	Resource not found

Code samples for "Create or update custom properties for an enterprise"

Request example

patch/enterprises/{enterprise}/properties/schema

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/properties/schema \
  -d '{"properties":[{"property_name":"environment","value_type":"single_select","required":true,"default_value":"production","description":"Prod or dev environment","allowed_values":["production","development"],"values_editable_by":"org_actors"},{"property_name":"service","value_type":"string"},{"property_name":"team","value_type":"string","description":"Team owning the repository"}]}'

Response

Status: 200

[
  {
    "property_name": "environment",
    "url": "https://HOSTNAME/orgs/github/properties/schema/environment",
    "source_type": "organization",
    "value_type": "single_select",
    "required": true,
    "default_value": "production",
    "description": "Prod or dev environment",
    "allowed_values": [
      "production",
      "development"
    ],
    "values_editable_by": "org_actors",
    "require_explicit_values": true
  },
  {
    "property_name": "service",
    "url": "https://HOSTNAME/orgs/github/properties/schema/service",
    "source_type": "organization",
    "value_type": "string"
  },
  {
    "property_name": "team",
    "url": "https://HOSTNAME/orgs/github/properties/schema/team",
    "source_type": "organization",
    "value_type": "string",
    "description": "Team owning the repository"
  }
]

Promote a custom property to an enterprise

Promotes an existing organization custom property to an enterprise.

To use this endpoint, the authenticated user must be an administrator for the enterprise.

Fine-grained access tokens for "Promote a custom property to an enterprise"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Custom properties" enterprise permissions (write)

Parameter für "Promote a custom property to an enterprise"

Header
Name, Typ, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, Typ, BESCHREIBUNG
`enterprise` string Erforderlich The slug version of the enterprise name.
`org` string Erforderlich The organization name. The name is not case sensitive.
`custom_property_name` string Erforderlich The custom property name

HTTP response status codes for "Promote a custom property to an enterprise"

Status code	BESCHREIBUNG
`200`	OK
`403`	Forbidden
`404`	Resource not found

Code samples for "Promote a custom property to an enterprise"

Request example

put/enterprises/{enterprise}/properties/schema/organizations/{org}/{custom_property_name}/promote

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/properties/schema/organizations/ORG/CUSTOM_PROPERTY_NAME/promote

Response

Status: 200

{
  "property_name": "environment",
  "url": "https://HOSTNAME/orgs/github/properties/schema/environment",
  "source_type": "organization",
  "value_type": "single_select",
  "required": true,
  "default_value": "production",
  "description": "Prod or dev environment",
  "allowed_values": [
    "production",
    "development"
  ]
}

Get a custom property for an enterprise

Gets a custom property that is defined for an enterprise. Enterprise members can read these properties.

Fine-grained access tokens for "Get a custom property for an enterprise"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Custom properties" enterprise permissions (read)

Parameter für "Get a custom property for an enterprise"

Header
Name, Typ, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, Typ, BESCHREIBUNG
`enterprise` string Erforderlich The slug version of the enterprise name.
`custom_property_name` string Erforderlich The custom property name

HTTP response status codes for "Get a custom property for an enterprise"

Status code	BESCHREIBUNG
`200`	OK
`403`	Forbidden
`404`	Resource not found

Code samples for "Get a custom property for an enterprise"

Request example

get/enterprises/{enterprise}/properties/schema/{custom_property_name}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/properties/schema/CUSTOM_PROPERTY_NAME

Response

Status: 200

{
  "property_name": "environment",
  "url": "https://HOSTNAME/orgs/github/properties/schema/environment",
  "source_type": "organization",
  "value_type": "single_select",
  "required": true,
  "default_value": "production",
  "description": "Prod or dev environment",
  "allowed_values": [
    "production",
    "development"
  ]
}

Create or update a custom property for an enterprise

Creates a new or updates an existing custom property that is defined for an enterprise.

To use this endpoint, the authenticated user must be an administrator for the enterprise.

Fine-grained access tokens for "Create or update a custom property for an enterprise"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Custom properties" enterprise permissions (write)

Parameter für "Create or update a custom property for an enterprise"

Header
Name, Typ, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, Typ, BESCHREIBUNG
`enterprise` string Erforderlich The slug version of the enterprise name.
`custom_property_name` string Erforderlich The custom property name

Körperparameter
Name, Typ, BESCHREIBUNG
`value_type` string Erforderlich The type of the value for the property Kann eine der folgenden sein: `string`, `single_select`, `multi_select`, `true_false`, `url`
`required` boolean Whether the property is required.
`default_value` null or string or array Default value of the property
`description` string or null Short description of the property
`allowed_values` array of strings or null An ordered list of the allowed values of the property. The property can have up to 200 allowed values.
`values_editable_by` string or null Who can edit the values of the property Kann eine der folgenden sein: `org_actors`, `org_and_repo_actors`, `null`
`require_explicit_values` boolean Whether setting properties values is mandatory

HTTP response status codes for "Create or update a custom property for an enterprise"

Status code	BESCHREIBUNG
`200`	OK
`403`	Forbidden
`404`	Resource not found

Code samples for "Create or update a custom property for an enterprise"

Request example

put/enterprises/{enterprise}/properties/schema/{custom_property_name}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/properties/schema/CUSTOM_PROPERTY_NAME \
  -d '{"value_type":"single_select","required":true,"default_value":"production","description":"Prod or dev environment","allowed_values":["production","development"]}'

Response

Status: 200

{
  "property_name": "environment",
  "url": "https://HOSTNAME/orgs/github/properties/schema/environment",
  "source_type": "organization",
  "value_type": "single_select",
  "required": true,
  "default_value": "production",
  "description": "Prod or dev environment",
  "allowed_values": [
    "production",
    "development"
  ]
}

Remove a custom property for an enterprise

Remove a custom property that is defined for an enterprise.

To use this endpoint, the authenticated user must be an administrator for the enterprise.

Fine-grained access tokens for "Remove a custom property for an enterprise"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Custom properties" enterprise permissions (write)

Parameter für "Remove a custom property for an enterprise"

Header
Name, Typ, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, Typ, BESCHREIBUNG
`enterprise` string Erforderlich The slug version of the enterprise name.
`custom_property_name` string Erforderlich The custom property name

HTTP response status codes for "Remove a custom property for an enterprise"

Status code	BESCHREIBUNG
`204`	A header with no content is returned.
`403`	Forbidden
`404`	Resource not found

Code samples for "Remove a custom property for an enterprise"

Request example

delete/enterprises/{enterprise}/properties/schema/{custom_property_name}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/properties/schema/CUSTOM_PROPERTY_NAME

A header with no content is returned.

Status: 204