immutable_releases_repos

Creates, updates, deletes, gets or lists an immutable_releases_repos resource.

Overview

Name	immutable_releases_repos
Type	Resource
Id	github.orgs.immutable_releases_repos

Fields

The following fields are returned by SELECT queries:

get_immutable_releases_settings_repositories

Response

Name	Datatype	Description
repositories	array
total_count	integer

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_immutable_releases_settings_repositories	select	org	page, per_page	List all of the repositories that have been selected for immutable releases enforcement in an organization. OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
enable_selected_repository_immutable_releases_organization	replace	org, repository_id		Adds a repository to the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for enforced_repositories must be configured to selected. OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
set_immutable_releases_settings_repositories	replace	org, selected_repository_ids		Replaces all repositories that have been selected for immutable releases enforcement in an organization. To use this endpoint, the organization immutable releases policy for enforced_repositories must be configured to selected. OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
disable_selected_repository_immutable_releases_organization	delete	org, repository_id		Removes a repository from the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for enforced_repositories must be configured to selected. OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
org	string	The organization name. The name is not case sensitive.
repository_id	integer	The unique identifier of the repository.
page	integer	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page	integer	The number of results per page (max 100). For more information, see "Using pagination in the REST API."

SELECT examples

get_immutable_releases_settings_repositories

List all of the repositories that have been selected for immutable releases enforcement in an organization.

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

SELECT
repositories,
total_count
FROM github.orgs.immutable_releases_repos
WHERE org = '{{ org }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;

REPLACE examples

enable_selected_repository_immutable_releases_organization

Adds a repository to the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for enforced_repositories must be configured to selected.

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

REPLACE github.orgs.immutable_releases_repos
SET 
-- No updatable properties
WHERE 
org = '{{ org }}' --required
AND repository_id = '{{ repository_id }}' --required;

set_immutable_releases_settings_repositories

Replaces all repositories that have been selected for immutable releases enforcement in an organization. To use this endpoint, the organization immutable releases policy for enforced_repositories must be configured to selected.

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

REPLACE github.orgs.immutable_releases_repos
SET 
selected_repository_ids = '{{ selected_repository_ids }}'
WHERE 
org = '{{ org }}' --required
AND selected_repository_ids = '{{ selected_repository_ids }}' --required;

DELETE examples

disable_selected_repository_immutable_releases_organization

Removes a repository from the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for enforced_repositories must be configured to selected.

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

DELETE FROM github.orgs.immutable_releases_repos
WHERE org = '{{ org }}' --required
AND repository_id = '{{ repository_id }}' --required
;