APIs.io Engineering Platform Dependabot API

Endpoints to manage Dependabot.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 19 operations across 12 paths, and defines 26 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.

19 operations 12 paths 26 schemas 3 DELETE11 GET1 PATCH4 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 Dependabot 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 19

Across 12 paths, the API surfaces 19 operations — 3 DELETE, 11 GET, 1 PATCH, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Dependabot 19

Endpoints to manage Dependabot.

GET

/enterprises/{enterprise}/dependabot/alerts

APIs.io Engineering Platform List Dependabot alerts for an enterprise

dependabot/list-alerts-for-enterprise 13 params → 200304403404422

GET

/orgs/{org}/dependabot/alerts

APIs.io Engineering Platform List Dependabot alerts for an organization

dependabot/list-alerts-for-org 13 params → 200304400403404422

GET

/orgs/{org}/dependabot/secrets

APIs.io Engineering Platform List organization secrets

dependabot/list-org-secrets 3 params → 200

GET

/orgs/{org}/dependabot/secrets/public-key

APIs.io Engineering Platform Get an organization public key

dependabot/get-org-public-key 1 param → 200

GET

/orgs/{org}/dependabot/secrets/{secret_name}

APIs.io Engineering Platform Get an organization secret

dependabot/get-org-secret 2 params → 200

PUT

/orgs/{org}/dependabot/secrets/{secret_name}

APIs.io Engineering Platform Create or update an organization secret

dependabot/create-or-update-org-secret 2 params body → 201204

DELETE

/orgs/{org}/dependabot/secrets/{secret_name}

APIs.io Engineering Platform Delete an organization secret

dependabot/delete-org-secret 2 params → 204

GET

/orgs/{org}/dependabot/secrets/{secret_name}/repositories

APIs.io Engineering Platform List selected repositories for an organization secret

dependabot/list-selected-repos-for-org-secret 4 params → 200

PUT

/orgs/{org}/dependabot/secrets/{secret_name}/repositories

APIs.io Engineering Platform Set selected repositories for an organization secret

dependabot/set-selected-repos-for-org-secret 2 params body → 204

PUT

/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}

APIs.io Engineering Platform Add selected repository to an organization secret

dependabot/add-selected-repo-to-org-secret 3 params → 204409

DELETE

/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}

APIs.io Engineering Platform Remove selected repository from an organization secret

dependabot/remove-selected-repo-from-org-secret 3 params → 204409

GET

/repos/{owner}/{repo}/dependabot/alerts

APIs.io Engineering Platform List Dependabot alerts for a repository

dependabot/list-alerts-for-repo 16 params → 200304400403404422

GET

/repos/{owner}/{repo}/dependabot/alerts/{alert_number}

APIs.io Engineering Platform Get a Dependabot alert

dependabot/get-alert 3 params → 200304403404

PATCH

/repos/{owner}/{repo}/dependabot/alerts/{alert_number}

APIs.io Engineering Platform Update a Dependabot alert

dependabot/update-alert 3 params body → 200400403404409422

GET

/repos/{owner}/{repo}/dependabot/secrets

APIs.io Engineering Platform List repository secrets

dependabot/list-repo-secrets 4 params → 200

GET

/repos/{owner}/{repo}/dependabot/secrets/public-key

APIs.io Engineering Platform Get a repository public key

dependabot/get-repo-public-key 2 params → 200

GET

/repos/{owner}/{repo}/dependabot/secrets/{secret_name}

APIs.io Engineering Platform Get a repository secret

dependabot/get-repo-secret 3 params → 200

PUT

/repos/{owner}/{repo}/dependabot/secrets/{secret_name}

APIs.io Engineering Platform Create or update a repository secret

dependabot/create-or-update-repo-secret 3 params body → 201204

DELETE

/repos/{owner}/{repo}/dependabot/secrets/{secret_name}

APIs.io Engineering Platform Delete a repository secret

dependabot/delete-repo-secret 3 params → 204

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are minimal-repository (87 properties), simple-repository (46 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

alert-number

integer

The security alert number.

alert-html-url

string

The GitHub URL of the alert resource.

alert-updated-at

string

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

code-of-conduct

object

Code Of Conduct

5 properties 4 required

alert-fixed-at

string

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

dependabot-alert-security-advisory

object

Details for the GitHub Security Advisory.

13 properties 13 required

basic-error

object

Basic Error

4 properties

alert-created-at

string

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

alert-dismissed-at

string

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

dependabot-secret

object

Set secrets for Dependabot.

3 properties 3 required

alert-auto-dismissed-at

string

The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

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

dependabot-alert

object

A Dependabot alert.

15 properties 14 required

dependabot-public-key

object

The public key used for setting Dependabot Secrets.

2 properties 2 required

minimal-repository

object

Minimal Repository

87 properties 46 required

empty-object

object

An object without any properties.

simple-repository

object

A GitHub repository.

46 properties 46 required

dependabot-alert-package

object

Details for the vulnerable package.

2 properties 2 required

dependabot-alert-security-vulnerability

object

Details pertaining to one vulnerable version range for the advisory.

4 properties 4 required

organization-dependabot-secret

object

Secrets for GitHub Dependabot for an organization.

5 properties 4 required

dependabot-alert-with-repository

object

A Dependabot alert.

16 properties 15 required

security-and-analysis

object

3 properties

alert-url

string

The REST API URL of the alert resource.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Dependabot

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

APIs.io Engineering Platform Dependabot API

Metadata

Authentication & Security 1

Paths & Operations 19

Schemas 26

Specification

Source

API Details

Provider

Explore more