Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rapid7 Credential API

Resources and operations for managing shared credentials.

Rapid7 Credential API is one of 50 APIs that Rapid7 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Credential. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 2 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://[region].api.insight.rapid7.com/ias/v1.

6 operations 2 paths 11 schemas 2 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://us.api.insight.rapid7.com/vm/v4
Resource Areas
1

Paths & Operations 6

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

Credential 6

Resources and operations for managing shared credentials.

GET
/api/3/shared_credentials
Shared Credentials
getSharedCredentials → 200401404500503
POST
/api/3/shared_credentials
Shared Credentials
createSharedCredential 1 param → 200400401500503
DELETE
/api/3/shared_credentials
Shared Credentials
deleteAllSharedCredentials → 200401404500503
GET
/api/3/shared_credentials/{id}
Shared Credential
getSharedCredential 1 param → 200401404500503
PUT
/api/3/shared_credentials/{id}
Shared Credential
updateSharedCredential 2 params → 200400401404500503
DELETE
/api/3/shared_credentials/{id}
Shared Credential
deleteSharedCredential 1 param → 200401404500503

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are SharedCredentialAccount (21 properties), SharedCredential (8 properties), BadRequestError (3 properties), NotFoundError (3 properties). Each schema is shown below with its type and property counts.

BadRequestError
object
3 properties 1 required
SharedCredentialAccount
object
21 properties
UnauthorizedError
object
3 properties 1 required
SharedCredential
object
8 properties 3 required
Links
object
1 property
ServiceUnavailableError
object
3 properties 1 required
NotFoundError
object
3 properties 1 required
Resources«SharedCredential»
object
2 properties
CreatedReference«CredentialID,Link»
object
2 properties
Link
object
2 properties
InternalServerError
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapid7-credential-api-openapi.yml Raw ↑

Other APIs Rapid7 publishes across the network.

Rapid7 InsightVM Cloud API
Rapid7 Insight Platform API
Rapid7 InsightIDR API
Rapid7 Accounts API
Rapid7 Administration API
Rapid7 Apps API
Rapid7 Asset API
Rapid7 Asset Discovery API
Rapid7 Asset Group API
Rapid7 Assets API
Rapid7 Attachments API
Rapid7 Attack Templates API