GitHub Enterprise の管理

Get an encryption key

Warning: The encryption at rest endpoints are currently in beta and are subject to change.

Gets information about the current key used for encryption at rest.

コードサンプル

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/enterprise/encryption

JavaScript (@octokit/core.js)

await octokit.request('GET /enterprise/encryption')

Default response

Status: 200 OK

{
  "updated_at": "2020-09-09T10:04:26.000Z",
  "primary_key_version": "9b24a469887e416787173383958c6fb9",
  "replica_key_version": "4621542832e447f285ea2dbeaf6f621b",
  "backup_key_version": "d067172e711b44a5963fe53b6b976c0f"
}

Update an encryption key

Warning: The encryption at rest endpoints are currently in beta and are subject to change.

Updates the current encryption at rest key with a new private key.

You can add a new encryption key as often as you need. When you add a new key, the old key is discarded.

Your enterprise won't experience downtime when you update the key, because the key vault that GitHub manages uses the "envelope" technique. For more information, see Encryption and decryption via the envelope technique in the Azure documentation.

Your 2048 bit RSA private key should be in PEM format. For more information, see "Configuring data encryption for your enterprise."

パラメータ

コードサンプル

Shell

curl \
  -X PATCH \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/enterprise/encryption \
  -d '{"key":"key"}'

JavaScript (@octokit/core.js)

await octokit.request('PATCH /enterprise/encryption', {
  key: 'key'
})

Response

Status: 202 Accepted

{
  "message": "Started update of private key for encryption at rest.",
  "status_url": "https://octocoders.github.io/api/v3/enterprise/encryption/status/6020dd37-ce35-49e8-a15b-0b9df458c049"
}

Disable encryption at rest

Warning: The encryption at rest endpoints are currently in beta and are subject to change.

Disables encryption at rest and deletes the encryption key. To freeze your enterprise, you can disable encryption at rest. For example, you can freeze your enterprise in the case of a breach. It takes approximately ten minutes to disable encryption at rest. To check the status, use the "Get an encryption status" REST API.

To unfreeze your enterprise after you've disabled encryption at rest, you must contact Support. For more information, see "Receiving enterprise support."

コードサンプル

Shell

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/enterprise/encryption

JavaScript (@octokit/core.js)

await octokit.request('DELETE /enterprise/encryption')

Response

Status: 202 Accepted

{
  "message": "Started disabling encryption at rest.",
  "status_url": "https://octocoders.github.io/api/v3/enterprise/encryption/status/db8ef711-ef82-464b-9013-5e0a1bb0031e"
}

Get an encryption status

Warning: The encryption at rest endpoints are currently in beta and are subject to change.

Checks the status of updating an encryption key or disabling encryption at rest.

パラメータ

コードサンプル

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/enterprise/encryption/status/REQUEST_ID

JavaScript (@octokit/core.js)

await octokit.request('GET /enterprise/encryption/status/{request_id}', {
  request_id: 'request_id'
})

Response

Status: 200 OK

{
  "result": "started",
  "error": null
}

Response if the url cannot be found

Status: 404 Not Found

Get statistics

There are a variety of types to choose from:

These statistics are cached and will be updated approximately every 10 minutes.

パラメータ

コードサンプル

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/enterprise/stats/TYPE

JavaScript (@octokit/core.js)

await octokit.request('GET /enterprise/stats/{type}', {
  type: 'type'
})

Default response

Status: 200 OK

{
  "repos": {
    "total_repos": 212,
    "root_repos": 194,
    "fork_repos": 18,
    "org_repos": 51,
    "total_pushes": 3082,
    "total_wikis": 15
  },
  "hooks": {
    "total_hooks": 27,
    "active_hooks": 23,
    "inactive_hooks": 4
  },
  "pages": {
    "total_pages": 36
  },
  "orgs": {
    "total_orgs": 33,
    "disabled_orgs": 0,
    "total_teams": 60,
    "total_team_members": 314
  },
  "users": {
    "total_users": 254,
    "admin_users": 45,
    "suspended_users": 21
  },
  "pulls": {
    "total_pulls": 86,
    "merged_pulls": 60,
    "mergeable_pulls": 21,
    "unmergeable_pulls": 3
  },
  "issues": {
    "total_issues": 179,
    "open_issues": 83,
    "closed_issues": 96
  },
  "milestones": {
    "total_milestones": 7,
    "open_milestones": 6,
    "closed_milestones": 1
  },
  "gists": {
    "total_gists": 178,
    "private_gists": 151,
    "public_gists": 25
  },
  "comments": {
    "total_commit_comments": 6,
    "total_gist_comments": 28,
    "total_issue_comments": 366,
    "total_pull_request_comments": 30
  }
}

Get the global announcement banner

Gets the current message and expiration date of the global announcement banner in your enterprise.

コードサンプル

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/enterprise/announcement

JavaScript (@octokit/core.js)

await octokit.request('GET /enterprise/announcement')

Default response

Status: 200 OK

{
  "announcement": "Very **important** announcement about _nothing_.",
  "expires_at": "2021-01-01T00:00:00.000+00:00"
}

Set the global announcement banner

Sets the message and expiration time for the global announcement banner in your enterprise.

パラメータ

コードサンプル

Shell

curl \
  -X PATCH \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/enterprise/announcement \
  -d '{"announcement":"announcement"}'

JavaScript (@octokit/core.js)

await octokit.request('PATCH /enterprise/announcement', {
  announcement: 'announcement'
})

Default response

Status: 200 OK

{
  "announcement": "Very **important** announcement about _nothing_.",
  "expires_at": "2021-01-01T00:00:00.000+00:00"
}

Remove the global announcement banner

Removes the global announcement banner in your enterprise.

コードサンプル

Shell

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/enterprise/announcement

JavaScript (@octokit/core.js)

await octokit.request('DELETE /enterprise/announcement')

Default Response

Status: 204 No Content

List global webhooks

パラメータ

コードサンプル

Shell

curl \
  -H "Accept: application/vnd.github.superpro-preview+json" \
  https://api.github.com/admin/hooks

JavaScript (@octokit/core.js)

await octokit.request('GET /admin/hooks', {
  mediaType: {
    previews: [
      'superpro'
    ]
  }
})

Default response

Status: 200 OK

[
  {
    "type": "Global",
    "id": 1,
    "name": "web",
    "active": true,
    "events": [
      "organization",
      "user"
    ],
    "config": {
      "url": "https://example.com",
      "content_type": "json",
      "insecure_ssl": "0",
      "secret": "********"
    },
    "updated_at": "2017-12-07T00:14:59Z",
    "created_at": "2017-12-07T00:14:59Z",
    "url": "https://api.github.com/admin/hooks/1",
    "ping_url": "https://api.github.com/admin/hooks/1/pings"
  }
]

プレビュー通知

application/vnd.github.superpro-preview+json

Create a global webhook

パラメータ

コードサンプル

Shell

curl \
  -X POST \
  -H "Accept: application/vnd.github.superpro-preview+json" \
  https://api.github.com/admin/hooks \
  -d '{"name":"name","config":{"url":"url","content_type":"content_type","secret":"secret","insecure_ssl":"insecure_ssl"}}'

JavaScript (@octokit/core.js)

await octokit.request('POST /admin/hooks', {
  name: 'name',
  config: {
    url: 'url',
    content_type: 'content_type',
    secret: 'secret',
    insecure_ssl: 'insecure_ssl'
  },
  mediaType: {
    previews: [
      'superpro'
    ]
  }
})

Default response

Status: 201 Created

{
  "type": "Global",
  "id": 1,
  "name": "web",
  "active": true,
  "events": [
    "organization",
    "user"
  ],
  "config": {
    "url": "https://example.com",
    "content_type": "json",
    "insecure_ssl": "0",
    "secret": "********"
  },
  "updated_at": "2017-12-07T00:14:59Z",
  "created_at": "2017-12-07T00:14:59Z",
  "url": "https://api.github.com/admin/hooks/1",
  "ping_url": "https://api.github.com/admin/hooks/1/pings"
}

プレビュー通知

application/vnd.github.superpro-preview+json

Get a global webhook

パラメータ

コードサンプル

Shell

curl \
  -H "Accept: application/vnd.github.superpro-preview+json" \
  https://api.github.com/admin/hooks/42

JavaScript (@octokit/core.js)

await octokit.request('GET /admin/hooks/{hook_id}', {
  hook_id: 42,
  mediaType: {
    previews: [
      'superpro'
    ]
  }
})

Default response

Status: 200 OK

{
  "type": "Global",
  "id": 1,
  "name": "web",
  "active": true,
  "events": [
    "organization",
    "user"
  ],
  "config": {
    "url": "https://example.com",
    "content_type": "json",
    "insecure_ssl": "0",
    "secret": "********"
  },
  "updated_at": "2017-12-07T00:14:59Z",
  "created_at": "2017-12-07T00:14:59Z",
  "url": "https://api.github.com/admin/hooks/1",
  "ping_url": "https://api.github.com/admin/hooks/1/pings"
}

プレビュー通知

application/vnd.github.superpro-preview+json

Update a global webhook

Parameters that are not provided will be overwritten with the default value or removed if no default exists.

パラメータ

コードサンプル

Shell

curl \
  -X PATCH \
  -H "Accept: application/vnd.github.superpro-preview+json" \
  https://api.github.com/admin/hooks/42 \
  -d '{"config":{"url":"url","content_type":"content_type","secret":"secret","insecure_ssl":"insecure_ssl"}}'

JavaScript (@octokit/core.js)

await octokit.request('PATCH /admin/hooks/{hook_id}', {
  hook_id: 42,
  config: {
    url: 'url',
    content_type: 'content_type',
    secret: 'secret',
    insecure_ssl: 'insecure_ssl'
  },
  mediaType: {
    previews: [
      'superpro'
    ]
  }
})

Default response

Status: 200 OK

{
  "type": "Global",
  "id": 1,
  "name": "web",
  "active": true,
  "events": [
    "organization"
  ],
  "config": {
    "url": "https://example.com",
    "content_type": "form",
    "insecure_ssl": "0"
  },
  "updated_at": "2017-12-07T00:14:59Z",
  "created_at": "2017-12-07T00:14:59Z",
  "url": "https://api.github.com/admin/hooks/1",
  "ping_url": "https://api.github.com/admin/hooks/1/pings"
}

プレビュー通知

application/vnd.github.superpro-preview+json

Delete a global webhook

パラメータ

コードサンプル

Shell

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.superpro-preview+json" \
  https://api.github.com/admin/hooks/42

JavaScript (@octokit/core.js)

await octokit.request('DELETE /admin/hooks/{hook_id}', {
  hook_id: 42,
  mediaType: {
    previews: [
      'superpro'
    ]
  }
})

Default Response

Status: 204 No Content

プレビュー通知

application/vnd.github.superpro-preview+json

Ping a global webhook

This will trigger a ping event to be sent to the webhook.

パラメータ

コードサンプル

Shell

curl \
  -X POST \
  -H "Accept: application/vnd.github.superpro-preview+json" \
  https://api.github.com/admin/hooks/42/pings

JavaScript (@octokit/core.js)

await octokit.request('POST /admin/hooks/{hook_id}/pings', {
  hook_id: 42,
  mediaType: {
    previews: [
      'superpro'
    ]
  }
})

Default Response

Status: 204 No Content

プレビュー通知

application/vnd.github.superpro-preview+json

Get license information

コードサンプル

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/enterprise/settings/license

JavaScript (@octokit/core.js)

await octokit.request('GET /enterprise/settings/license')

Default response

Status: 200 OK

{
  "seats": 1400,
  "seats_used": 1316,
  "seats_available": 84,
  "kind": "standard",
  "days_until_expiration": 365,
  "expire_at": "2016/02/06 12:41:52 -0600"
}

Create an organization

パラメータ

コードサンプル

Shell

curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/admin/organizations \
  -d '{"login":"login","admin":"admin"}'

JavaScript (@octokit/core.js)

await octokit.request('POST /admin/organizations', {
  login: 'login',
  admin: 'admin'
})

Default response

Status: 201 Created

{
  "login": "github",
  "id": 1,
  "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
  "url": "https://api.github.com/orgs/github",
  "repos_url": "https://api.github.com/orgs/github/repos",
  "events_url": "https://api.github.com/orgs/github/events",
  "hooks_url": "https://api.github.com/orgs/github/hooks",
  "issues_url": "https://api.github.com/orgs/github/issues",
  "members_url": "https://api.github.com/orgs/github/members{/member}",
  "public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
  "avatar_url": "https://github.com/images/error/octocat_happy.gif",
  "description": "A great organization"
}

Update an organization name

パラメータ

コードサンプル

Shell

curl \
  -X PATCH \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/admin/organizations/ORG \
  -d '{"login":"login"}'

JavaScript (@octokit/core.js)

await octokit.request('PATCH /admin/organizations/{org}', {
  org: 'org',
  login: 'login'
})

Response

Status: 202 Accepted

{
  "message": "Job queued to rename organization. It may take a few minutes to complete.",
  "url": "https://<hostname>/api/v3/organizations/1"
}

List public keys

パラメータ

コードサンプル

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/admin/keys

JavaScript (@octokit/core.js)

await octokit.request('GET /admin/keys')

Default response

Status: 200 OK

[
  {
    "key_id": "012345678912345678",
    "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
    "user_id": 232,
    "repository_id": null
  },
  {
    "key_id": "012345678912345678",
    "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
    "user_id": null,
    "repository_id": 2333,
    "id": "2",
    "url": "https://api.github.com/repos/octocat/Hello-World/keys/2"
  }
]

Delete a public key

パラメータ

コードサンプル

Shell

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/admin/keys/KEY_IDS

JavaScript (@octokit/core.js)

await octokit.request('DELETE /admin/keys/{key_ids}', {
  key_ids: 'key_ids'
})

Default Response

Status: 204 No Content

List personal access tokens

Lists personal access tokens for all users, including admin users.

パラメータ

コードサンプル

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/admin/tokens

JavaScript (@octokit/core.js)

await octokit.request('GET /admin/tokens')

Default response

Status: 200 OK

[
  {
    "id": 1,
    "url": "https://api.github.com/authorizations/1",
    "scopes": [
      "public_repo"
    ],
    "token": "",
    "token_last_eight": "12345678",
    "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8",
    "app": {
      "url": "http://my-github-app.com",
      "name": "my github app",
      "client_id": "abcde12345fghij67890"
    },
    "note": "optional note",
    "note_url": "http://optional/note/url",
    "updated_at": "2011-09-06T20:39:23Z",
    "created_at": "2011-09-06T17:26:27Z",
    "fingerprint": "jklmnop12345678"
  }
]

Delete a personal access token

Deletes a personal access token. Returns a 403 - Forbidden status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error.

パラメータ

コードサンプル

Shell

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/admin/tokens/42

JavaScript (@octokit/core.js)

await octokit.request('DELETE /admin/tokens/{token_id}', {
  token_id: 42
})

Default Response

Status: 204 No Content

Delete a user

Deleting a user will delete all their repositories, gists, applications, and personal settings. Suspending a user is often a better option.

You can delete any user account except your own.

パラメータ

コードサンプル

Shell

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/admin/users/USERNAME

JavaScript (@octokit/core.js)

await octokit.request('DELETE /admin/users/{username}', {
  username: 'username'
})

Default Response

Status: 204 No Content

Create an impersonation OAuth token

パラメータ

コードサンプル

Shell

curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/admin/users/USERNAME/authorizations \
  -d '{"scopes":["scopes"]}'

JavaScript (@octokit/core.js)

await octokit.request('POST /admin/users/{username}/authorizations', {
  username: 'username',
  scopes: [
    'scopes'
  ]
})

Default response

Status: 201 Created

{
  "id": 1,
  "url": "https://api.github.com/authorizations/1",
  "scopes": [
    "public_repo"
  ],
  "token": "abcdefgh12345678",
  "token_last_eight": "12345678",
  "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8",
  "app": {
    "url": "http://my-github-app.com",
    "name": "my github app",
    "client_id": "abcde12345fghij67890"
  },
  "note": "optional note",
  "note_url": "http://optional/note/url",
  "updated_at": "2011-09-06T20:39:23Z",
  "created_at": "2011-09-06T17:26:27Z",
  "fingerprint": ""
}

Delete an impersonation OAuth token

パラメータ

コードサンプル

Shell

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/admin/users/USERNAME/authorizations

JavaScript (@octokit/core.js)

await octokit.request('DELETE /admin/users/{username}/authorizations', {
  username: 'username'
})

Default Response

Status: 204 No Content

Suspend a user

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

You can suspend any user account except your own.

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

パラメータ

コードサンプル

Shell

curl \
  -X PUT \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/users/USERNAME/suspended \
  -d '{"reason":"reason"}'

JavaScript (@octokit/core.js)

await octokit.request('PUT /users/{username}/suspended', {
  username: 'username',
  reason: 'reason'
})

Default Response

Status: 204 No Content

Unsuspend a user

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.

パラメータ

コードサンプル

Shell

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/users/USERNAME/suspended \
  -d '{"reason":"reason"}'

JavaScript (@octokit/core.js)

await octokit.request('DELETE /users/{username}/suspended', {
  username: 'username',
  reason: 'reason'
})

Default Response

Status: 204 No Content