How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Venafi V Satellite API

The VSatellite API from Venafi — 11 operation(s) for vsatellite.

Venafi V Satellite API is one of 58 APIs that Venafi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include VSatellite. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 14 operations across 11 paths, and defines 41 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 6 base URLs: https://api.venafi.cloud, https://api.eu.venafi.cloud, https://api.au.venafi.cloud, https://api.uk.venafi.cloud, https://api.sg.venafi.cloud, https://api.ca.venafi.cloud.

14 operations 11 paths 41 schemas 1 DELETE6 GET1 PATCH5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.venafi.cloud
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Venafi V Satellite API declares 2 security schemes for authenticating requests. An API key is passed in the header as service-account (service-account). An API key is passed in the header as tppl-api-key (tppl-api-key).

Paths & Operations 14

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

VSatellite 14
POST
/v1/edgeinstances/{id}/update
Trigger manual update of Satellite Instance
create-edgeinstances-update 1 param → 202400404412
GET
/v1/edgeencryptionkeys
Retrieve Satellite Encryption Keys
edgeencryptionkeys_getAll 1 param → 200
GET
/v1/edgeencryptionkeys/{id}
Retrieve SatelliteEncryption Key By Id
edgeencryptionkeys_getById 1 param → 200400404412
GET
/v1/edgeinstances
Retrieve Satellite Instances
edgeinstances_getAll 1 param → 200
GET
/v1/edgeinstances/{id}
Retrieve Satellite Instance By Id
edgeinstances_getById 2 params → 200400404412
PUT
/v1/edgeinstances/{id}
Update Satellite Instance
edgeinstances_update 1 param body → 200400404412
POST
/v1/pairingcodes/satellite
Create Pairing Code for Satellite Instance
pairingcodes_create body → 201400
POST
/v1/recoverycodes/satellite
Create Recovery Code for Satellite Instance
recoverycodes_create body → 201400
GET
/v1/edgeworkers
Retrieve Satellite Workers
edgeworkers_getAll 1 param → 200
POST
/v1/edgeworkers
Create Satellite Worker
edgeworkers_create body → 201400412
POST
/v1/edgeworkers/{id}/pair
Pair Satellite Worker with Satellite Instance
edgeworkers_pair 1 param body → 200400412
DELETE
/v1/edgeworkers/{id}
Delete Satellite Worker
edgeworker_delete 1 param → 204400404412
GET
/v1/updatesconfig
Retrieve Updates configuration
updatesconfig_get → 200
PATCH
/v1/updatesconfig
Create or Update Configuration
updatesconfig_patch body → 200

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are EdgeInstanceInformation (27 properties), EdgeWorkerHealthDetails (11 properties), EdgeWorkerInformation (11 properties), EdgeInstanceHealthDetails (8 properties). Each schema is shown below with its type and property counts.

NamespaceChartDetails
object
2 properties
EdgeWorkerStatusDetailsInformation
object
2 properties
EdgeInstanceHealthDetails
object
8 properties
EncryptionKeysResponse
object
1 property
EdgeType
string
ChartDetails
object
2 properties
AnyValue9
Can be any value - string, number, boolean, array or object.
WorkerServiceStatusDetails
object
2 properties
NamespaceStatusDetails
object
3 properties
EdgeWorkerDeleteResponse
object
2 properties
EdgeInstanceStatusDetailsInformation
object
2 properties
EdgeStatus
string
NodeCondition
object
4 properties
ErrorResponse11
object
1 property
RecoveryCodeInformation
object
8 properties
NodeInfo
object
1 property
ErrorInformation9
object
3 properties
WorkerStatus
string
EdgeWorkerRequest
object
3 properties
UpdatesConfigResponse
object
1 property
NodeStatusDetails
object
2 properties
ProductEntitlement2
string
RecoveryCodeRequest
object
1 property 1 required
EdgeInstanceConnectionDetails
object
8 properties
PairingCodeRequest
object
3 properties
EncryptionKeyInformation
object
5 properties
EdgeWorkersResponse
object
1 property
EdgeInstanceRequest
object
2 properties 1 required
UpdatesConfigRequest
object
1 property 1 required
SchedulerPatternInformation3
object
1 property 1 required
PodStatusDetails
object
7 properties
EdgeWorkerHealthDetails
object
11 properties
EdgeWorkerInformation
object
11 properties
UpgradeStatus
string
KeyAlgorithm2
string
HSMEdgeStatus
string
EdgeInstanceResponse
object
1 property
EdgeInstanceInformation
object
27 properties
PairingCodeInformation
object
7 properties
DailyPatternInformation
object
2 required
WeeklyPatternInformation
object
3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

venafi-vsatellite-api-openapi.yml Raw ↑

Other APIs Venafi publishes across the network.

Venafi Access Management APIs API
Venafi AlgorithmSelector APIs API
Venafi Application API
Venafi Authentication Server APIs API
Venafi Certificate Approvals API
Venafi Certificate Auto-renewal Monitoring API
Venafi Certificate Discovery API
Venafi Certificate Expiration Reports API
Venafi Certificate Import API
Venafi Certificate Installations API
Venafi Certificate Inventory Monitoring API
Venafi Certificate Management APIs API
Where this information came from

This is an independent, third-party profile of Venafi V Satellite API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.