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

Replicated instances API

The instances API from Replicated — 10 operation(s) for instances.

Replicated instances API is one of 22 APIs that Replicated publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include instances. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and an API reference.

This API exposes 11 operations across 10 paths, and defines 16 schemas. It is described by OpenAPI 2.0, at version 3.0.0.

Requests are made against the base URL https://api.replicated.com/vendor/v3.

11 operations 10 paths 16 schemas 5 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
3.0.0
Base URL
https://api.replicated.com/vendor/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Replicated instances API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key).

Paths & Operations 11

Across 10 paths, the API surfaces 11 operations — 5 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

instances 11
GET
/app/{app_id}/customer/{customer_id}/instance/{instance_id}/running-images
Get running images for an instance.
getCustomerInstanceRunningImages 4 params → 200401403404
GET
/app/{app_id}/customer/{customer_id}/instance/{instance_id}/scan
Get security scan summaries for an instance.
getCustomerInstanceScan 4 params → 200401403404
POST
/app/{app_id}/customer/{customer_id}/instance/{instance_id}/scan/trigger
Trigger a security scan for an instance image.
triggerCustomerInstanceScan 4 params → 200400401403404
GET
/app/{app_id}/customer/{customer_id}/instance/{instance_id}/tags
Get tags for a instance.
getCustomerInstanceTags 4 params → 201401403404
PUT
/app/{app_id}/customer/{customer_id}/instance/{instance_id}/tags
Create or update the tags for an instance.
updateCustomerInstanceTags 4 params → 201401403404
GET
/app/{app_id}/customer/{customer_id}/instances
List customer instances.
listCustomerInstances 2 params → 200400401403404
GET
/app/{app_id}/instance-tag-schema
Get the instance tag schema for an app.
getInstanceTagSchema 1 param → 200401403404
POST
/app/{app_id}/instance-tags
Get tags for multiple instances.
getCustomerInstancesTagsBulk 2 params → 200400401403404
POST
/app/{app_id}/instances/archive
Batch archive customer instances.
batchArchiveCustomerInstances 2 params → 200400401403404
PUT
/instance/{instance_id}/archive
Archive an instance.
archiveCustomerInstance 2 params → 200401403404
PUT
/instance/{instance_id}/unarchive
Unarchive an instance.
unarchiveCustomerInstance 2 params → 200401403404

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are CustomerInstance (24 properties), SecurityScanWrapper (16 properties), VulnDetail (10 properties), SecurityScanInfo (9 properties). Each schema is shown below with its type and property counts.

InstanceTag
object
4 properties
TriggerCustomerInstanceScanBody
object
TriggerCustomerInstanceScanBody contains the body parameters for triggering a scan
3 properties 2 required
SecurityScanWrapper
object
16 properties
CustomerInstance
object
24 properties
SourceType
string
SourceType classifies an image as either a Replicated platform image or a vendor application image, so that consumers can distinguish vulnerabilities in Replic…
BatchArchiveInstance
object
3 properties
ScannerDescriptor
object
2 properties
CustomerInstanceVersionHistory
object
9 properties
SecurityScanInfo
object
9 properties
InstanceTags
array
VulnCounts
object
5 properties
InstanceSecuritySummary
object
InstanceSecuritySummary represents aggregated security information for an instance
3 properties
VulnDetail
object
10 properties
ImageSource
object
5 properties
InstanceTagDTO
object
InstanceTagDTO is a response-only shape without instanceId
3 properties
SkippedInstance
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

replicated-instances-api-openapi.yml Raw ↑

Other APIs Replicated publishes across the network.

Replicated apps API
Replicated channelReleases API
Replicated channels API
Replicated clusterAddons API
Replicated clusters API
Replicated cmx API
Replicated customers API
Replicated customHostnames API
Replicated enterprisePortal API
Replicated externalRegistries API
Replicated networks API
Replicated notifications API