APIs.io Engineering Platform Apps API

Information for integrations and installations.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 29 operations across 23 paths, and defines 23 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

29 operations 23 paths 23 schemas 6 DELETE14 GET2 PATCH5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

2015-07-09

Base URL

https://{bucketname}.s3.amazonaws.com

Authentication

API Key

Contact

Mike Ralphson

License

Apache 2.0 License

View terms

Resource Areas

Authentication & Security 1

APIs.io Engineering Platform Apps API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

hmac — Amazon Signature authorization v4

Paths & Operations 29

Across 23 paths, the API surfaces 29 operations — 6 DELETE, 14 GET, 2 PATCH, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Apps 29

Information for integrations and installations.

GET

/app

APIs.io Engineering Platform Get the authenticated app

apps/get-authenticated → 200

POST

/app-manifests/{code}/conversions

APIs.io Engineering Platform Create a GitHub App from a manifest

apps/create-from-manifest 1 param → 201404422

GET

/app/hook/config

APIs.io Engineering Platform Get a webhook configuration for an app

apps/get-webhook-config-for-app → 200

PATCH

/app/hook/config

APIs.io Engineering Platform Update a webhook configuration for an app

apps/update-webhook-config-for-app body → 200

GET

/app/hook/deliveries

APIs.io Engineering Platform List deliveries for an app webhook

apps/list-webhook-deliveries 3 params → 200400422

GET

/app/hook/deliveries/{delivery_id}

APIs.io Engineering Platform Get a delivery for an app webhook

apps/get-webhook-delivery 1 param → 200400422

POST

/app/hook/deliveries/{delivery_id}/attempts

APIs.io Engineering Platform Redeliver a delivery for an app webhook

apps/redeliver-webhook-delivery 1 param → 202400422

GET

/app/installation-requests

APIs.io Engineering Platform List installation requests for the authenticated app

apps/list-installation-requests-for-authenticated-app 2 params → 200304401

GET

/app/installations

APIs.io Engineering Platform List installations for the authenticated app

apps/list-installations 4 params → 200

GET

/app/installations/{installation_id}

APIs.io Engineering Platform Get an installation for the authenticated app

apps/get-installation 1 param → 200404

DELETE

/app/installations/{installation_id}

APIs.io Engineering Platform Delete an installation for the authenticated app

apps/delete-installation 1 param → 204404

POST

/app/installations/{installation_id}/access_tokens

APIs.io Engineering Platform Create an installation access token for an app

apps/create-installation-access-token 1 param body → 201403401404422

PUT

/app/installations/{installation_id}/suspended

APIs.io Engineering Platform Suspend an app installation

apps/suspend-installation 1 param → 204404

DELETE

/app/installations/{installation_id}/suspended

APIs.io Engineering Platform Unsuspend an app installation

apps/unsuspend-installation 1 param → 204404

DELETE

/applications/{client_id}/grant

APIs.io Engineering Platform Delete an app authorization

apps/delete-authorization 1 param body → 204422

POST

/applications/{client_id}/token

APIs.io Engineering Platform Check a token

apps/check-token 1 param body → 200422404

PATCH

/applications/{client_id}/token

APIs.io Engineering Platform Reset a token

apps/reset-token 1 param body → 200422

DELETE

/applications/{client_id}/token

APIs.io Engineering Platform Delete an app token

apps/delete-token 1 param body → 204422

POST

/applications/{client_id}/token/scoped

APIs.io Engineering Platform Create a scoped access token

apps/scope-token 1 param body → 200401403404422

GET

/apps/{app_slug}

APIs.io Engineering Platform Get an app

apps/get-by-slug 1 param → 200403404

GET

/installation/repositories

APIs.io Engineering Platform List repositories accessible to the app installation

apps/list-repos-accessible-to-installation 2 params → 200403304401

DELETE

/installation/token

APIs.io Engineering Platform Revoke an installation access token

apps/revoke-installation-access-token → 204

GET

/orgs/{org}/installation

APIs.io Engineering Platform Get an organization installation for the authenticated app

apps/get-org-installation 1 param → 200

GET

/repos/{owner}/{repo}/installation

APIs.io Engineering Platform Get a repository installation for the authenticated app

apps/get-repo-installation 2 params → 200301404

GET

/user/installations

APIs.io Engineering Platform List app installations accessible to the user access token

apps/list-installations-for-authenticated-user 2 params → 200304403401

GET

/user/installations/{installation_id}/repositories

APIs.io Engineering Platform List repositories accessible to the user access token

apps/list-installation-repos-for-authenticated-user 3 params → 200404403304

PUT

/user/installations/{installation_id}/repositories/{repository_id}

APIs.io Engineering Platform Add a repository to an app installation

apps/add-repo-to-installation-for-authenticated-user 2 params → 204403304404

DELETE

/user/installations/{installation_id}/repositories/{repository_id}

APIs.io Engineering Platform Remove a repository from an app installation

apps/remove-repo-from-installation-for-authenticated-user 2 params → 204403304404

GET

/users/{username}/installation

APIs.io Engineering Platform Get a user installation for the authenticated app

apps/get-user-installation 1 param → 200

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are repository (95 properties), app-permissions (45 properties), simple-user (21 properties), nullable-simple-user (21 properties). Each schema is shown below with its type and property counts.

nullable-simple-user

object

A GitHub user.

21 properties 18 required

integration

object

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…

17 properties 11 required

repository

object

A repository on GitHub.

95 properties 73 required

enterprise

object

An enterprise on GitHub.

10 properties 8 required

webhook-config-secret

string

If provided, the secret will be used as the key to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-serve…

basic-error

object

Basic Error

4 properties

hook-delivery-item

object

Delivery made by a webhook, without request and response information.

12 properties 11 required

installation-token

object

Authentication token for a GitHub App installed on a user or org.

8 properties 2 required

hook-delivery

object

Delivery made by a webhook.

15 properties 13 required

validation-error

object

Validation Error

3 properties 2 required

nullable-scoped-installation

object

7 properties 5 required

app-permissions

object

The permissions granted to the user access token.

45 properties

scim-error

object

Scim Error

6 properties

validation-error-simple

object

Validation Error Simple

3 properties 2 required

simple-user

object

A GitHub user.

21 properties 18 required

webhook-config-url

string

The URL to which the payloads will be delivered.

nullable-license-simple

object

License Simple

6 properties 5 required

authorization

object

The authorization for an OAuth app, GitHub App, or a Personal Access Token.

15 properties 13 required

installation

object

Installation

20 properties 17 required

integration-installation-request

object

Request to install an integration on a target

5 properties 4 required

webhook-config-insecure-ssl

webhook-config-content-type

string

The media type used to serialize the payloads. Supported values include json and form. The default is form.

webhook-config

object

Configuration object of the webhook

4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Apps

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

APIs.io Engineering Platform Apps API

Metadata

Authentication & Security 1

Paths & Operations 29

Schemas 23

Specification

Source

API Details

Provider

Explore more