The minimum timestamp to query for stats
", + "description": "The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The maximum timestamp to query for stats
", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The minimum timestamp to query for stats
", + "description": "The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The maximum timestamp to query for stats
", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The minimum timestamp to query for stats
", + "description": "The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The maximum timestamp to query for stats
", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The minimum timestamp to query for stats
", + "description": "The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The maximum timestamp to query for stats
", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The minimum timestamp to query for stats
", + "description": "The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The maximum timestamp to query for stats
", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The minimum timestamp to query for stats
", + "description": "The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The maximum timestamp to query for stats
", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The minimum timestamp to query for stats
", + "description": "The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The maximum timestamp to query for stats
", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The minimum timestamp to query for stats
", + "description": "The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The maximum timestamp to query for stats
", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The minimum timestamp to query for stats
", + "description": "The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The maximum timestamp to query for stats
", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
OK
" } ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/audit-log/stream-key", + "title": "Get the audit log stream key for encrypting secrets", + "category": "enterprise-admin", + "subcategory": "audit-log", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "The stream key for the audit log streaming configuration was retrieved successfully.
", + "example": { + "key_id": "123", + "key": "actual-public-key-value" + }, + "schema": { + "title": "stream-key", + "description": "Audit Log Streaming Public Key", + "type": "object", + "properties": { + "key_id": { + "type": "string" + }, + "key": { + "type": "string" + } + }, + "required": [ + "key_id", + "key" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Retrieves the audit log streaming public key for encrypting secrets.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "The stream key for the audit log streaming configuration was retrieved successfully.
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/audit-log/streams", + "title": "List audit log stream configurations for an enterprise", + "category": "enterprise-admin", + "subcategory": "audit-log", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "OK
", + "example": [ + { + "id": 1, + "stream_type": "Splunk", + "stream_details": "US", + "enabled": true, + "created_at": "2024-06-06T08:00:00Z", + "updated_at": "2024-06-06T08:00:00Z", + "paused_at": null + } + ], + "schema": { + "title": "List audit log streaming configurations", + "description": "Lists the audit log streaming configurations for an enterprise.", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "stream_type": { + "type": "string" + }, + "stream_details": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "paused_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + } + }, + "required": [ + "id", + "stream_type", + "stream_details", + "enabled", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists the configured audit log streaming configurations for an enterprise.\nThis only lists configured streams for supported providers.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/enterprises/{enterprise}/audit-log/streams", + "title": "Create an audit log streaming configuration for an enterprise", + "category": "enterprise-admin", + "subcategory": "audit-log", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "boolean", + "name": "enabled", + "in": "body", + "description": "This setting pauses or resumes a stream.
", + "isRequired": true + }, + { + "type": "string", + "name": "stream_type", + "in": "body", + "description": "The audit log streaming provider. The name is case sensitive.
", + "isRequired": true, + "enum": [ + "Azure Blob Storage", + "Azure Event Hubs", + "Amazon S3", + "Splunk", + "HTTPS Event Collector", + "Google Cloud Storage", + "Datadog" + ] + }, + { + "type": "object", + "name": "vendor_specific", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "AzureBlobConfig", + "description": "Azure Blob Config for audit log streaming configuration.
", + "isRequired": [ + "key_id", + "encrypted_sas_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "key_id", + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets.
", + "isRequired": true + }, + { + "type": "string", + "name": "encrypted_sas_url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "AzureHubConfig", + "description": "Azure Event Hubs Config for audit log streaming configuration.
", + "isRequired": [ + "name", + "encrypted_connstring", + "key_id" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "Instance name of Azure Event Hubs
", + "isRequired": true + }, + { + "type": "string", + "name": "encrypted_connstring", + "description": "Encrypted Connection String for Azure Event Hubs
", + "isRequired": true + }, + { + "type": "string", + "name": "key_id", + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "AmazonS3OIDCConfig", + "description": "Amazon S3 OIDC Config for audit log streaming configuration.
", + "isRequired": [ + "arn_role", + "authentication_type", + "bucket", + "key_id", + "region" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "bucket", + "description": "Amazon S3 Bucket Name.
", + "isRequired": true + }, + { + "type": "string", + "name": "region", + "description": "AWS S3 Bucket Region.
", + "isRequired": true + }, + { + "type": "string", + "name": "key_id", + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets.
", + "isRequired": true + }, + { + "type": "string", + "name": "authentication_type", + "description": "Authentication Type for Amazon S3.
", + "isRequired": true, + "enum": [ + "oidc" + ] + }, + { + "type": "string", + "name": "arn_role", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "AmazonS3AccessKeysConfig", + "description": "Amazon S3 Access Keys Config for audit log streaming configuration.
", + "isRequired": [ + "authentication_type", + "bucket", + "encrypted_access_key_id", + "encrypted_secret_key", + "key_id", + "region" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "bucket", + "description": "Amazon S3 Bucket Name.
", + "isRequired": true + }, + { + "type": "string", + "name": "region", + "description": "Amazon S3 Bucket Name.
", + "isRequired": true + }, + { + "type": "string", + "name": "key_id", + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets.
", + "isRequired": true + }, + { + "type": "string", + "name": "authentication_type", + "description": "Authentication Type for Amazon S3.
", + "isRequired": true, + "enum": [ + "access_keys" + ] + }, + { + "type": "string", + "name": "encrypted_secret_key", + "description": "Encrypted AWS Secret Key.
", + "isRequired": true + }, + { + "type": "string", + "name": "encrypted_access_key_id", + "description": "Encrypted AWS Access Key ID.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "SplunkConfig", + "description": "Splunk Config for Audit Log Stream Configuration
", + "isRequired": [ + "domain", + "encrypted_token", + "key_id", + "port", + "ssl_verify" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "domain", + "description": "Domain of Splunk instance.
", + "isRequired": true + }, + { + "type": "integer", + "name": "port", + "description": "The port number for connecting to Splunk.
", + "isRequired": true + }, + { + "type": "string", + "name": "key_id", + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets.
", + "isRequired": true + }, + { + "type": "string", + "name": "encrypted_token", + "description": "Encrypted Token.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "ssl_verify", + "description": "SSL verification helps ensure your events are sent to your Splunk endpoint securely.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "GoogleCloudConfig", + "description": "Google Cloud Config for audit log streaming configuration.
", + "isRequired": [ + "bucket", + "key_id", + "encrypted_json_credentials" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "bucket", + "description": "Google Cloud Bucket Name
", + "isRequired": true + }, + { + "type": "string", + "name": "key_id", + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets.
", + "isRequired": true + }, + { + "type": "string", + "name": "encrypted_json_credentials", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "DatadogConfig", + "description": "Datadog Config for audit log streaming configuration.
", + "isRequired": [ + "encrypted_token", + "site", + "key_id" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "encrypted_token", + "description": "Encrypted Splunk token.
", + "isRequired": true + }, + { + "type": "string", + "name": "site", + "description": "Datadog Site to use.
", + "isRequired": true, + "enum": [ + "US", + "US3", + "US5", + "EU1", + "US1-FED", + "AP1" + ] + }, + { + "type": "string", + "name": "key_id", + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets.
", + "isRequired": true + } + ] + } + ], + "oneOfObject": true + } + ], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "enabled": false, + "stream_type": "Azure Event Hubs", + "vendor_specific": { + "namespace": "newnamespace", + "shared_access_key_name": "newaccesskeyname", + "shared_access_key": "newaccesskey", + "event_hub_name": "neweventhub" + } + }, + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "The audit log stream configuration was created successfully.
", + "example": { + "id": 1, + "stream_type": "Splunk", + "stream_details": "US", + "enabled": true, + "created_at": "2024-06-06T08:00:00Z", + "updated_at": "2024-06-06T08:00:00Z", + "paused_at": null + }, + "schema": { + "title": "Get an audit log streaming configuration", + "description": "Get an audit log streaming configuration for an enterprise.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "stream_type": { + "type": "string" + }, + "stream_details": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "paused_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "stream_type", + "stream_details", + "enabled", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Creates an audit log streaming configuration for any of the supported streaming endpoints: Azure Blob Storage, Azure Event Hubs, Amazon S3, Splunk, Google Cloud Storage, Datadog.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "The audit log stream configuration was created successfully.
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/audit-log/streams/{stream_id}", + "title": "List one audit log streaming configuration via a stream ID", + "category": "enterprise-admin", + "subcategory": "audit-log", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "stream_id", + "description": "The ID of the audit log stream configuration.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "stream_id": "STREAM_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Lists one audit log stream configuration via stream ID.
", + "example": { + "id": 1, + "stream_type": "Splunk", + "stream_details": "US", + "enabled": true, + "created_at": "2024-06-06T08:00:00Z", + "updated_at": "2024-06-06T08:00:00Z", + "paused_at": null + }, + "schema": { + "title": "Get an audit log streaming configuration", + "description": "Get an audit log streaming configuration for an enterprise.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "stream_type": { + "type": "string" + }, + "stream_details": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "paused_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "stream_type", + "stream_details", + "enabled", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists one audit log stream configuration via a stream ID.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Lists one audit log stream configuration via stream ID.
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/audit-log/streams/{stream_id}", + "title": "Update an existing audit log stream configuration", + "category": "enterprise-admin", + "subcategory": "audit-log", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "stream_id", + "description": "The ID of the audit log stream configuration.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "boolean", + "name": "enabled", + "in": "body", + "description": "This setting pauses or resumes a stream.
", + "isRequired": true + }, + { + "type": "string", + "name": "stream_type", + "in": "body", + "description": "The audit log streaming provider. The name is case sensitive.
", + "isRequired": true, + "enum": [ + "Azure Blob Storage", + "Azure Event Hubs", + "Amazon S3", + "Splunk", + "HTTPS Event Collector", + "Google Cloud Storage", + "Datadog" + ] + }, + { + "type": "object", + "name": "vendor_specific", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "AzureBlobConfig", + "description": "Azure Blob Config for audit log streaming configuration.
", + "isRequired": [ + "key_id", + "encrypted_sas_url" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "key_id", + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets.
", + "isRequired": true + }, + { + "type": "string", + "name": "encrypted_sas_url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "AzureHubConfig", + "description": "Azure Event Hubs Config for audit log streaming configuration.
", + "isRequired": [ + "name", + "encrypted_connstring", + "key_id" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "Instance name of Azure Event Hubs
", + "isRequired": true + }, + { + "type": "string", + "name": "encrypted_connstring", + "description": "Encrypted Connection String for Azure Event Hubs
", + "isRequired": true + }, + { + "type": "string", + "name": "key_id", + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "AmazonS3OIDCConfig", + "description": "Amazon S3 OIDC Config for audit log streaming configuration.
", + "isRequired": [ + "arn_role", + "authentication_type", + "bucket", + "key_id", + "region" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "bucket", + "description": "Amazon S3 Bucket Name.
", + "isRequired": true + }, + { + "type": "string", + "name": "region", + "description": "AWS S3 Bucket Region.
", + "isRequired": true + }, + { + "type": "string", + "name": "key_id", + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets.
", + "isRequired": true + }, + { + "type": "string", + "name": "authentication_type", + "description": "Authentication Type for Amazon S3.
", + "isRequired": true, + "enum": [ + "oidc" + ] + }, + { + "type": "string", + "name": "arn_role", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "AmazonS3AccessKeysConfig", + "description": "Amazon S3 Access Keys Config for audit log streaming configuration.
", + "isRequired": [ + "authentication_type", + "bucket", + "encrypted_access_key_id", + "encrypted_secret_key", + "key_id", + "region" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "bucket", + "description": "Amazon S3 Bucket Name.
", + "isRequired": true + }, + { + "type": "string", + "name": "region", + "description": "Amazon S3 Bucket Name.
", + "isRequired": true + }, + { + "type": "string", + "name": "key_id", + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets.
", + "isRequired": true + }, + { + "type": "string", + "name": "authentication_type", + "description": "Authentication Type for Amazon S3.
", + "isRequired": true, + "enum": [ + "access_keys" + ] + }, + { + "type": "string", + "name": "encrypted_secret_key", + "description": "Encrypted AWS Secret Key.
", + "isRequired": true + }, + { + "type": "string", + "name": "encrypted_access_key_id", + "description": "Encrypted AWS Access Key ID.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "SplunkConfig", + "description": "Splunk Config for Audit Log Stream Configuration
", + "isRequired": [ + "domain", + "encrypted_token", + "key_id", + "port", + "ssl_verify" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "domain", + "description": "Domain of Splunk instance.
", + "isRequired": true + }, + { + "type": "integer", + "name": "port", + "description": "The port number for connecting to Splunk.
", + "isRequired": true + }, + { + "type": "string", + "name": "key_id", + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets.
", + "isRequired": true + }, + { + "type": "string", + "name": "encrypted_token", + "description": "Encrypted Token.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "ssl_verify", + "description": "SSL verification helps ensure your events are sent to your Splunk endpoint securely.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "GoogleCloudConfig", + "description": "Google Cloud Config for audit log streaming configuration.
", + "isRequired": [ + "bucket", + "key_id", + "encrypted_json_credentials" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "bucket", + "description": "Google Cloud Bucket Name
", + "isRequired": true + }, + { + "type": "string", + "name": "key_id", + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets.
", + "isRequired": true + }, + { + "type": "string", + "name": "encrypted_json_credentials", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "DatadogConfig", + "description": "Datadog Config for audit log streaming configuration.
", + "isRequired": [ + "encrypted_token", + "site", + "key_id" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "encrypted_token", + "description": "Encrypted Splunk token.
", + "isRequired": true + }, + { + "type": "string", + "name": "site", + "description": "Datadog Site to use.
", + "isRequired": true, + "enum": [ + "US", + "US3", + "US5", + "EU1", + "US1-FED", + "AP1" + ] + }, + { + "type": "string", + "name": "key_id", + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets.
", + "isRequired": true + } + ] + } + ], + "oneOfObject": true + } + ], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "enabled": false, + "stream_type": "Azure Event Hubs", + "vendor_specific": { + "namespace": "newnamespace", + "shared_access_key_name": "newaccesskeyname", + "shared_access_key": "newaccesskey", + "event_hub_name": "neweventhub" + } + }, + "parameters": { + "enterprise": "ENTERPRISE", + "stream_id": "STREAM_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Successful update
", + "example": { + "id": 1, + "stream_type": "Splunk", + "stream_details": "US", + "enabled": true, + "created_at": "2024-06-06T08:00:00Z", + "updated_at": "2024-06-06T08:00:00Z", + "paused_at": null + }, + "schema": { + "title": "Get an audit log streaming configuration", + "description": "Get an audit log streaming configuration for an enterprise.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "stream_type": { + "type": "string" + }, + "stream_details": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "paused_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "id", + "stream_type", + "stream_details", + "enabled", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Updates an existing audit log stream configuration for an enterprise.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Successful update
" + }, + { + "httpStatusCode": "422", + "description": "Validation error
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/audit-log/streams/{stream_id}", + "title": "Delete an audit log streaming configuration for an enterprise", + "category": "enterprise-admin", + "subcategory": "audit-log", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "stream_id", + "description": "The ID of the audit log stream configuration.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "stream_id": "STREAM_ID" + } + }, + "response": { + "statusCode": "204", + "description": "The audit log stream configuration was deleted successfully.
" + } + } + ], + "previews": [], + "descriptionHTML": "Deletes an existing audit log stream configuration for an enterprise.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "The audit log stream configuration was deleted successfully.
" + } + ] } ], "billing": [ @@ -377581,7 +378772,7 @@ }, { "name": "min_timestamp", - "description": "The minimum timestamp to query for stats
", + "description": "The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The maximum timestamp to query for stats
", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The minimum timestamp to query for stats
", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats
", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "sort", - "description": "The property to sort the results by.
", - "in": "query", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "last_rate_limited_timestamp", - "last_request_timestamp", - "rate_limited_request_count", - "subject_name", - "total_request_count" - ], - "default": "total_request_count" - } - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"API Insights\" organization permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "subject_type": "installation", - "subject_id": 954453, - "subject_name": "GitHub Actions", - "integration_id": 124345, - "total_request_count": 544665, - "rate_limited_request_count": 13, - "last_request_timestamp": "2024-09-18T15:43:03Z", - "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" - } - ], - "schema": { - "title": "Subject Stats", - "description": "API Insights usage subject stats for an organization", - "type": "array", - "items": { - "type": "object", - "properties": { - "subject_type": { - "type": "string" - }, - "subject_name": { - "type": "string" - }, - "subject_id": { - "type": "integer", - "format": "int64" - }, - "total_request_count": { - "type": "integer" - }, - "rate_limited_request_count": { - "type": "integer" - }, - "last_rate_limited_timestamp": { - "type": [ - "string", - "null" - ] - }, - "last_request_timestamp": { - "type": "string" - } - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/insights/api/summary-stats", - "title": "Get summary stats", - "category": "orgs", - "subcategory": "api-insights", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats
", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats
", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"API Insights\" organization permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "total_request_count": 34225, - "rate_limited_request_count": 23 - }, - "schema": { - "title": "Summary Stats", - "description": "API Insights usage summary stats for an organization", - "type": "object", - "properties": { - "total_request_count": { - "description": "The total number of requests within the queried time period", - "type": "integer", - "format": "int64" - }, - "rate_limited_request_count": { - "description": "The total number of requests that were rate limited within the queried time period", - "type": "integer", - "format": "int64" - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/insights/api/summary-stats/users/{user_id}", - "title": "Get summary stats by user", - "category": "orgs", - "subcategory": "api-insights", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "user_id", - "in": "path", - "description": "The ID of the user to query for stats
", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats
", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats
", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"API Insights\" organization permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG", - "user_id": "USER_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "total_request_count": 34225, - "rate_limited_request_count": 23 - }, - "schema": { - "title": "Summary Stats", - "description": "API Insights usage summary stats for an organization", - "type": "object", - "properties": { - "total_request_count": { - "description": "The total number of requests within the queried time period", - "type": "integer", - "format": "int64" - }, - "rate_limited_request_count": { - "description": "The total number of requests that were rate limited within the queried time period", - "type": "integer", - "format": "int64" - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Get overall statistics of API requests within the organization for a user.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}", - "title": "Get summary stats by actor", - "category": "orgs", - "subcategory": "api-insights", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats
", + "description": "The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The maximum timestamp to query for stats
", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The property to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "last_rate_limited_timestamp", + "last_request_timestamp", + "rate_limited_request_count", + "subject_name", + "total_request_count" + ], + "default": "total_request_count" + } + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"API Insights\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "subject_type": "installation", + "subject_id": 954453, + "subject_name": "GitHub Actions", + "integration_id": 124345, + "total_request_count": 544665, + "rate_limited_request_count": 13, + "last_request_timestamp": "2024-09-18T15:43:03Z", + "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" + } + ], + "schema": { + "title": "Subject Stats", + "description": "API Insights usage subject stats for an organization", + "type": "array", + "items": { + "type": "object", + "properties": { + "subject_type": { + "type": "string" + }, + "subject_name": { + "type": "string" + }, + "subject_id": { + "type": "integer", + "format": "int64" + }, + "total_request_count": { + "type": "integer" + }, + "rate_limited_request_count": { + "type": "integer" + }, + "last_rate_limited_timestamp": { + "type": [ + "string", + "null" + ] + }, + "last_request_timestamp": { + "type": "string" + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/insights/api/summary-stats", + "title": "Get summary stats", + "category": "orgs", + "subcategory": "api-insights", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", "required": true, "schema": { "type": "string" } }, + { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
", + "example": { + "total_request_count": 34225, + "rate_limited_request_count": 23 + }, + "schema": { + "title": "Summary Stats", + "description": "API Insights usage summary stats for an organization", + "type": "object", + "properties": { + "total_request_count": { + "description": "The total number of requests within the queried time period", + "type": "integer", + "format": "int64" + }, + "rate_limited_request_count": { + "description": "The total number of requests that were rate limited within the queried time period", + "type": "integer", + "format": "int64" + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/insights/api/summary-stats/users/{user_id}", + "title": "Get summary stats by user", + "category": "orgs", + "subcategory": "api-insights", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "user_id", + "in": "path", + "description": "The ID of the user to query for stats
", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
", + "example": { + "total_request_count": 34225, + "rate_limited_request_count": 23 + }, + "schema": { + "title": "Summary Stats", + "description": "API Insights usage summary stats for an organization", + "type": "object", + "properties": { + "total_request_count": { + "description": "The total number of requests within the queried time period", + "type": "integer", + "format": "int64" + }, + "rate_limited_request_count": { + "description": "The total number of requests that were rate limited within the queried time period", + "type": "integer", + "format": "int64" + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Get overall statistics of API requests within the organization for a user.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}", + "title": "Get summary stats by actor", + "category": "orgs", + "subcategory": "api-insights", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The minimum timestamp to query for stats
", + "description": "The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The maximum timestamp to query for stats
", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The minimum timestamp to query for stats
", + "description": "The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The maximum timestamp to query for stats
", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The minimum timestamp to query for stats
", + "description": "The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The maximum timestamp to query for stats
", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The minimum timestamp to query for stats
", + "description": "The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The maximum timestamp to query for stats
", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
", - "example": { - "status": "running", - "progress": [ - { - "status": "DONE", - "key": "Appliance core components" - }, - { - "status": "DONE", - "key": "GitHub utilities" - }, - { - "status": "DONE", - "key": "GitHub applications" - }, - { - "status": "CONFIGURING", - "key": "GitHub services" - }, - { - "status": "PENDING", - "key": "Reloading appliance services" - } - ] - }, - "schema": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "progress": { - "type": "array", - "items": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "key": { - "type": "string" - } - }, - "required": [ - "status", - "key" - ] - } - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "This endpoint allows you to check the status of the most recent configuration process:
\nNote that you may need to wait several seconds after you start a process before you can check its status.
\nThe different statuses are:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Status | Description |
|---|---|
PENDING | The job has not started yet |
CONFIGURING | The job is running |
DONE | The job has finished correctly |
FAILED | The job has finished unexpectedly |
OK
" - }, - { - "httpStatusCode": "401", - "description": "Unauthorized
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "post", - "requestPath": "/setup/api/configure", - "title": "Start a configuration process", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [], - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "202", - "description": "Response
" - } - } - ], - "previews": [], - "descriptionHTML": "This endpoint allows you to start a configuration process at any time for your updated settings to take effect:
", - "statusCodes": [ - { - "httpStatusCode": "202", - "description": "Accepted
" - }, - { - "httpStatusCode": "401", - "description": "Unauthorized
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/setup/api/maintenance", - "title": "Get the maintenance status", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [], - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "status": "scheduled", - "scheduled_time": "Tuesday, January 22 at 15:34 -0800", - "connection_services": [ - { - "name": "git operations", - "number": 0 - }, - { - "name": "mysql queries", - "number": 233 - }, - { - "name": "aqueduct jobs", - "number": 34 - }, - { - "name": "resque jobs", - "number": 54 - } - ] - }, - "schema": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "scheduled_time": { - "type": "string" - }, - "connection_services": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "number": { - "type": "integer" - } - }, - "required": [ - "name", - "number" - ] - } - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Check your installation's maintenance status:
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "401", - "description": "Unauthorized
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "post", - "requestPath": "/setup/api/maintenance", - "title": "Enable or disable maintenance mode", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "maintenance", - "in": "body", - "description": "A JSON string with the attributes enabled and when.
The possible values for enabled are true and false. When it's false, the attribute when is ignored and the maintenance mode is turned off. when defines the time period when the maintenance was enabled.
The possible values for when are now or any date parseable by mojombo/chronic.
Response
", - "example": { - "status": "scheduled", - "scheduled_time": "Tuesday, January 22 at 15:34 -0800", - "connection_services": [ - { - "name": "git operations", - "number": 0 - }, - { - "name": "mysql queries", - "number": 233 - }, - { - "name": "aqueduct jobs", - "number": 34 - }, - { - "name": "resque jobs", - "number": 54 - } - ] - }, - "schema": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "scheduled_time": { - "type": "string" - }, - "connection_services": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "number": { - "type": "integer" - } - }, - "required": [ - "name", - "number" - ] - } - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Note
\n\nThe request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
OK
" - }, - { - "httpStatusCode": "401", - "description": "Unauthorized
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/setup/api/settings", - "title": "Get settings", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [], - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "enterprise": { - "private_mode": false, - "public_pages": false, - "subdomain_isolation": true, - "signup_enabled": false, - "github_hostname": "ghe.local", - "identicons_host": "dotcom", - "http_proxy": null, - "auth_mode": "default", - "expire_sessions": false, - "admin_password": null, - "configuration_id": 1401777404, - "configuration_run_count": 4, - "avatar": { - "enabled": false, - "uri": "" - }, - "customer": { - "name": "GitHub", - "email": "stannis@themannis.biz", - "uuid": "af6cac80-e4e1-012e-d822-1231380e52e9", - "secret_key_data": "-----BEGIN PGP PRIVATE KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\n\nlQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx...\n-----END PGP PRIVATE KEY BLOCK-----\n", - "public_key_data": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\n\nmI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7....\n-----END PGP PUBLIC KEY BLOCK-----\n" - }, - "license": { - "seats": 0, - "evaluation": false, - "perpetual": false, - "unlimited_seating": true, - "support_key": "ssh-rsa AAAAB3N....", - "ssh_allowed": true, - "cluster_support": false, - "expire_at": "2016-04-27T00:00:00-07:00" - }, - "github_ssl": { - "enabled": false, - "cert": null, - "key": null - }, - "ldap": { - "host": null, - "port": 0, - "base": [], - "uid": null, - "bind_dn": null, - "password": null, - "method": "Plain", - "search_strategy": "detect", - "user_groups": [], - "admin_group": null, - "virtual_attribute_enabled": false, - "recursive_group_search": false, - "posix_support": true, - "user_sync_emails": false, - "user_sync_keys": false, - "user_sync_interval": 4, - "team_sync_interval": 4, - "sync_enabled": false, - "reconciliation": { - "user": null, - "org": null - }, - "profile": { - "uid": "uid", - "name": null, - "mail": null, - "key": null - } - }, - "cas": { - "url": null - }, - "saml": { - "sso_url": null, - "certificate": null, - "certificate_path": null, - "issuer": null, - "idp_initiated_sso": false, - "disable_admin_demote": false - }, - "github_oauth": { - "client_id": "12313412", - "client_secret": "kj123131132", - "organization_name": "Homestar Runners", - "organization_team": "homestarrunners/characters" - }, - "smtp": { - "enabled": true, - "address": "smtp.example.com", - "authentication": "plain", - "port": "1234", - "domain": "blah", - "username": "foo", - "user_name": "mr_foo", - "enable_starttls_auto": true, - "password": "bar", - "discard-to-noreply-address": true, - "support_address": "enterprise@github.com", - "support_address_type": "email", - "noreply_address": "noreply@github.com" - }, - "ntp": { - "primary_server": "0.pool.ntp.org", - "secondary_server": "1.pool.ntp.org" - }, - "timezone": null, - "snmp": { - "enabled": false, - "community": "" - }, - "syslog": { - "enabled": false, - "server": null, - "protocol_name": "udp" - }, - "assets": null, - "pages": { - "enabled": true - }, - "collectd": { - "enabled": false, - "server": null, - "port": 0, - "encryption": null, - "username": null, - "password": null - }, - "mapping": { - "enabled": true, - "tileserver": null, - "basemap": "company.map-qsz2zrvs", - "token": null - }, - "load_balancer": null - }, - "run_list": [ - "recipe[enterprise-configure]" - ] - }, - "schema": { - "type": "object", - "properties": { - "enterprise": { - "type": "object", - "properties": { - "private_mode": { - "type": "boolean" - }, - "public_pages": { - "type": "boolean" - }, - "subdomain_isolation": { - "type": "boolean" - }, - "signup_enabled": { - "type": "boolean" - }, - "github_hostname": { - "type": "string" - }, - "identicons_host": { - "type": "string" - }, - "http_proxy": { - "type": [ - "string", - "null" - ] - }, - "auth_mode": { - "type": "string" - }, - "expire_sessions": { - "type": "boolean" - }, - "admin_password": { - "type": [ - "string", - "null" - ] - }, - "configuration_id": { - "type": "integer" - }, - "configuration_run_count": { - "type": "integer" - }, - "avatar": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "uri": { - "type": "string" - } - } - }, - "customer": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "uuid": { - "type": "string" - }, - "secret_key_data": { - "type": "string" - }, - "public_key_data": { - "type": "string" - } - } - }, - "license": { - "type": "object", - "properties": { - "seats": { - "type": "integer" - }, - "evaluation": { - "type": "boolean" - }, - "perpetual": { - "type": "boolean" - }, - "unlimited_seating": { - "type": "boolean" - }, - "support_key": { - "type": "string" - }, - "ssh_allowed": { - "type": "boolean" - }, - "cluster_support": { - "type": "boolean" - }, - "expire_at": { - "type": "string" - } - } - }, - "github_ssl": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "cert": { - "type": [ - "string", - "null" - ] - }, - "key": { - "type": [ - "string", - "null" - ] - } - } - }, - "ldap": { - "type": "object", - "properties": { - "host": { - "type": [ - "string", - "null" - ] - }, - "port": { - "type": "integer" - }, - "base": { - "type": "array", - "items": {} - }, - "uid": { - "type": [ - "string", - "null" - ] - }, - "bind_dn": { - "type": [ - "string", - "null" - ] - }, - "password": { - "type": [ - "string", - "null" - ] - }, - "method": { - "type": "string" - }, - "search_strategy": { - "type": "string" - }, - "user_groups": { - "type": "array", - "items": {} - }, - "admin_group": { - "type": [ - "string", - "null" - ] - }, - "virtual_attribute_enabled": { - "type": "boolean" - }, - "recursive_group_search": { - "type": "boolean" - }, - "posix_support": { - "type": "boolean" - }, - "user_sync_emails": { - "type": "boolean" - }, - "user_sync_keys": { - "type": "boolean" - }, - "user_sync_interval": { - "type": "integer" - }, - "team_sync_interval": { - "type": "integer" - }, - "sync_enabled": { - "type": "boolean" - }, - "reconciliation": { - "type": "object", - "properties": { - "user": { - "type": [ - "string", - "null" - ] - }, - "org": { - "type": [ - "string", - "null" - ] - } - } - }, - "profile": { - "type": "object", - "properties": { - "uid": { - "type": "string" - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "mail": { - "type": [ - "string", - "null" - ] - }, - "key": { - "type": [ - "string", - "null" - ] - } - } - } - } - }, - "cas": { - "type": "object", - "properties": { - "url": { - "type": [ - "string", - "null" - ] - } - } - }, - "saml": { - "type": "object", - "properties": { - "sso_url": { - "type": [ - "string", - "null" - ] - }, - "certificate": { - "type": [ - "string", - "null" - ] - }, - "certificate_path": { - "type": [ - "string", - "null" - ] - }, - "issuer": { - "type": [ - "string", - "null" - ] - }, - "idp_initiated_sso": { - "type": "boolean" - }, - "disable_admin_demote": { - "type": "boolean" - } - } - }, - "github_oauth": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "client_secret": { - "type": "string" - }, - "organization_name": { - "type": "string" - }, - "organization_team": { - "type": "string" - } - } - }, - "smtp": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "address": { - "type": "string" - }, - "authentication": { - "type": "string" - }, - "port": { - "type": "string" - }, - "domain": { - "type": "string" - }, - "username": { - "type": "string" - }, - "user_name": { - "type": "string" - }, - "enable_starttls_auto": { - "type": "boolean" - }, - "password": { - "type": "string" - }, - "discard-to-noreply-address": { - "type": "boolean" - }, - "support_address": { - "type": "string" - }, - "support_address_type": { - "type": "string" - }, - "noreply_address": { - "type": "string" - } - } - }, - "ntp": { - "type": "object", - "properties": { - "primary_server": { - "type": "string" - }, - "secondary_server": { - "type": "string" - } - } - }, - "timezone": { - "type": [ - "string", - "null" - ] - }, - "snmp": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "community": { - "type": "string" - } - } - }, - "syslog": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "server": { - "type": [ - "string", - "null" - ] - }, - "protocol_name": { - "type": "string" - } - } - }, - "assets": { - "type": [ - "string", - "null" - ] - }, - "pages": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "collectd": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "server": { - "type": [ - "string", - "null" - ] - }, - "port": { - "type": "integer" - }, - "encryption": { - "type": [ - "string", - "null" - ] - }, - "username": { - "type": [ - "string", - "null" - ] - }, - "password": { - "type": [ - "string", - "null" - ] - } - } - }, - "mapping": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "tileserver": { - "type": [ - "string", - "null" - ] - }, - "basemap": { - "type": "string" - }, - "token": { - "type": [ - "string", - "null" - ] - } - } - }, - "load_balancer": { - "type": [ - "string", - "null" - ] - } - } - }, - "run_list": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Gets the settings for your instance. To change settings, see the Set settings endpoint.
\nNote
\n\nYou cannot retrieve the management console password with the Enterprise administration API.
\nOK
" - }, - { - "httpStatusCode": "401", - "description": "Unauthorized
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "put", - "requestPath": "/setup/api/settings", - "title": "Set settings", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "settings", - "in": "body", - "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.
", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "204", - "request": { - "contentType": "application/x-www-form-urlencoded", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "settings": "{ \"enterprise\": { \"public_pages\": true }}" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" - } - } - ], - "previews": [], - "descriptionHTML": "Applies settings on your instance. For a list of the available settings, see the Get settings endpoint.
\nNotes:
\napplication/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.ghe-set-password utility to change the management console password. For more information, see \"Command-line utilities.\"No Content
" - }, - { - "httpStatusCode": "401", - "description": "Unauthorized
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "get", - "requestPath": "/setup/api/settings/authorized-keys", - "title": "Get all authorized SSH keys", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [], - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - }, - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - }, - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "pretty-print": { - "type": "string" - } - } - } - } - } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "401", - "description": "Unauthorized
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "post", - "requestPath": "/setup/api/settings/authorized-keys", - "title": "Add an authorized SSH key", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "authorized_key", - "in": "body", - "description": "The public SSH key.
", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/x-www-form-urlencoded", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - }, - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - }, - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "pretty-print": { - "type": "string" - } - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Note: The request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
Created
" - }, - { - "httpStatusCode": "401", - "description": "Unauthorized
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "delete", - "requestPath": "/setup/api/settings/authorized-keys", - "title": "Remove an authorized SSH key", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "authorized_key", - "in": "body", - "description": "The public SSH key.
", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/x-www-form-urlencoded", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - }, - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - }, - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "pretty-print": { - "type": "string" - } - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Note: The request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
OK
" - }, - { - "httpStatusCode": "401", - "description": "Unauthorized
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "post", - "requestPath": "/setup/api/start", - "title": "Create a GitHub license", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "license", - "in": "body", - "description": "The content of your .ghl license file.
", - "isRequired": true - }, - { - "type": "string", - "name": "password", - "in": "body", - "description": "You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.
" - }, - { - "type": "string", - "name": "settings", - "in": "body", - "description": "An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.
" - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "multipart/form-data", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "license": "@enterprise.ghl", - "password": "secret" - } - }, - "response": { - "statusCode": "202", - "description": "Response
" - } - } - ], - "previews": [], - "descriptionHTML": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.
\nNote that you need to POST to /setup/api/configure to start the actual configuration process.
When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Accepted
" - }, - { - "httpStatusCode": "401", - "description": "Unauthorized
" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME", - "verb": "post", - "requestPath": "/setup/api/upgrade", - "title": "Upgrade a license", - "category": "enterprise-admin", - "subcategory": "management-console", - "parameters": [], - "bodyParameters": [ - { - "type": "string", - "name": "license", - "in": "body", - "description": "The content of your new .ghl license file.
" - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "multipart/form-data", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "license": "@enterprise.ghl" - } - }, - "response": { - "statusCode": "202", - "description": "Response
" - } - } - ], - "previews": [], - "descriptionHTML": "This API upgrades your license and also triggers the configuration process.
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Accepted
" - }, - { - "httpStatusCode": "401", - "description": "Unauthorized
" - } - ] - } - ], "org-pre-receive-hooks": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -327749,45 +326407,51 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "examples": [ false - ] + ], + "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { "type": "boolean", @@ -328020,37 +326684,37 @@ "type": "boolean", "name": "advanced_security_enabled_for_new_repositories", "in": "body", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Endpoint closing down notice. Please use code security configurations instead.
\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether Dependabot alerts is automatically enabled for new repositories and repositories transferred to this organization.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Endpoint closing down notice. Please use code security configurations instead.
\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether Dependabot security updates is automatically enabled for new repositories and repositories transferred to this organization.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Endpoint closing down notice. Please use code security configurations instead.
\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Endpoint closing down notice. Please use code security configurations instead.
\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Endpoint closing down notice. Please use code security configurations instead.
\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Endpoint closing down notice. Please use code security configurations instead.
\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.
\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Warning
\n\nClosing down notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Updates the organization's profile and member privileges.
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Warning
\n\nClosing down notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.
Warning
\n\nClosing down notice: Code security product enablement for new repositories through the organization API is closing down and will be replaced with code security configurations in a future GitHub Enterprise Server version.
\nUpdates the organization's profile and member privileges.
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"
\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org, write:org, or repo scopes to use this endpoint.
Warning
\n\nClosing down notice: The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use code security configurations instead. For more information, see the changelog.
\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"
\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org, write:org, or repo scopes to use this endpoint.