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

Akuity Kargo Service API

The KargoService API from Akuity — 39 operation(s) for kargoservice.

Akuity Kargo Service API is one of 8 APIs that Akuity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 51 operations across 39 paths, and defines 86 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://akuity.cloud.

51 operations 39 paths 86 schemas 4 DELETE17 GET2 PATCH22 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://akuity.cloud/api/v1
Authentication
HTTP Basic
Contact
Resource Areas
1

Authentication & Security 1

Akuity Kargo Service API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic auth: username = AKUITYAPIKEYID, password = AKUITYAPIKEYSECRET.

Paths & Operations 51

Across 39 paths, the API surfaces 51 operations — 4 DELETE, 17 GET, 2 PATCH, 22 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

KargoService 51
GET
/api/v1/orgs/{organization_id}/kargo/instances
List Kargo Instances
KargoService_ListKargoInstances 2 params → 200401403404default
POST
/api/v1/orgs/{organization_id}/kargo/instances
Create Kargo Instance
KargoService_CreateKargoInstance 1 param body → 200401403404default
POST
/api/v1/orgs/{organization_id}/kargo/instances/promotions-events
Get Promotion Events
KargoService_GetPromotionEvents 1 param body → 200401403404default
POST
/api/v1/orgs/{organization_id}/kargo/instances/promotions-stats
Get Promotion Stats
KargoService_GetPromotionStats 1 param body → 200401403404default
POST
/api/v1/orgs/{organization_id}/kargo/instances/stage-specific-stats
Get Stage Specific Stats
KargoService_GetStageSpecificStats 1 param body → 200401403404default
DELETE
/api/v1/orgs/{organization_id}/kargo/instances/{id}
Delete Instance
KargoService_DeleteInstance 3 params → 200401403404default
PATCH
/api/v1/orgs/{organization_id}/kargo/instances/{id}
Patch Kargo Instance
KargoService_PatchKargoInstance 2 params body → 200401403404default
PUT
/api/v1/orgs/{organization_id}/kargo/instances/{id}/transfer
Update Kargo Instance Workspace
KargoService_UpdateKargoInstanceWorkspace 2 params body → 200401403404default
GET
/api/v1/orgs/{organization_id}/kargo/instances/{instance_id}/agents
List Kargo Instance Agents
KargoService_ListKargoInstanceAgents 3 params → 200401403404default
POST
/api/v1/orgs/{organization_id}/kargo/instances/{instance_id}/agents
Create Kargo Instance Agent
KargoService_CreateKargoInstanceAgent 2 params body → 200401403404default
PUT
/api/v1/orgs/{organization_id}/kargo/instances/{instance_id}/agents
Update Kargo Instance Agents
KargoService_UpdateKargoInstanceAgents 2 params body → 200401403404default
POST
/api/v1/orgs/{organization_id}/kargo/instances/{instance_id}/agents/regenerate-manifests
Regenerate Manifests
KargoService_RegenerateManifests 2 params body → 200401403404default
POST
/api/v1/orgs/{organization_id}/kargo/instances/{instance_id}/agents/rotate-credentials
Rotate Instance Agent Credentials
KargoService_RotateInstanceAgentCredentials 2 params body → 200401403404default
POST
/api/v1/orgs/{organization_id}/kargo/instances/{instance_id}/agents/set-maintenance-mode
Set Agent Maintenance Mode
KargoService_SetAgentMaintenanceMode 2 params body → 200401403404default
POST
/api/v1/orgs/{organization_id}/kargo/instances/{instance_id}/agents/version
Update Instance Agent Version
KargoService_UpdateInstanceAgentVersion 2 params body → 200401403404default
DELETE
/api/v1/orgs/{organization_id}/kargo/instances/{instance_id}/agents/{id}
Delete Instance Agent
KargoService_DeleteInstanceAgent 4 params → 200401403404default
GET
/api/v1/orgs/{organization_id}/kargo/instances/{instance_id}/agents/{id}
Get Kargo Instance Agent
KargoService_GetKargoInstanceAgent 4 params → 200401403404default
PUT
/api/v1/orgs/{organization_id}/kargo/instances/{instance_id}/agents/{id}
Update Kargo Instance Agent
KargoService_UpdateKargoInstanceAgent 3 params body → 200401403404default
GET
/api/v1/orgs/{organization_id}/kargo/instances/{instance_id}/agents/{id}/command
Get Instance Agent Command
KargoService_GetInstanceAgentCommand 7 params → 200401403404default
GET
/api/v1/orgs/{organization_id}/kargo/instances/{instance_id}/agents/{id}/manifests
Get Kargo Instance Agent Manifests
KargoService_GetKargoInstanceAgentManifests 5 params → 200401403404default
GET
/api/v1/orgs/{organization_id}/kargo/instances/{name}
Get Kargo Instance
KargoService_GetKargoInstance 3 params → 200401403404default
GET
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances
List Kargo Instances
KargoService_ListKargoInstances_1 2 params → 200401403404default
POST
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances
Create Kargo Instance
KargoService_CreateKargoInstance_1 2 params body → 200401403404default
POST
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/promotions-events
Get Promotion Events
KargoService_GetPromotionEvents_1 2 params body → 200401403404default
POST
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/promotions-stats
Get Promotion Stats
KargoService_GetPromotionStats_1 2 params body → 200401403404default
POST
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/stage-specific-stats
Get Stage Specific Stats
KargoService_GetStageSpecificStats_1 2 params body → 200401403404default
DELETE
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/{id}
Delete Instance
KargoService_DeleteInstance_1 3 params → 200401403404default
PATCH
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/{id}
Patch Kargo Instance
KargoService_PatchKargoInstance_1 3 params body → 200401403404default
POST
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/{id}/apply
Apply Kargo Instance
KargoService_ApplyKargoInstance 3 params body → 200401403404default
GET
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/{id}/export
Export Kargo Instance
KargoService_ExportKargoInstance 3 params → 200401403404default
PUT
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/{id}/transfer
Update Kargo Instance Workspace
KargoService_UpdateKargoInstanceWorkspace_1 3 params body → 200401403404default
GET
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/{instance_id}/agents
List Kargo Instance Agents
KargoService_ListKargoInstanceAgents_1 3 params → 200401403404default
POST
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/{instance_id}/agents
Create Kargo Instance Agent
KargoService_CreateKargoInstanceAgent_1 3 params body → 200401403404default
PUT
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/{instance_id}/agents
Update Kargo Instance Agents
KargoService_UpdateKargoInstanceAgents_1 3 params body → 200401403404default
POST
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/{instance_id}/agents/regenerate-manifests
Regenerate Manifests
KargoService_RegenerateManifests_1 3 params body → 200401403404default
POST
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/{instance_id}/agents/rotate-credentials
Rotate Instance Agent Credentials
KargoService_RotateInstanceAgentCredentials_1 3 params body → 200401403404default
POST
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/{instance_id}/agents/set-maintenance-mode
Set Agent Maintenance Mode
KargoService_SetAgentMaintenanceMode_1 3 params body → 200401403404default
POST
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/{instance_id}/agents/version
Update Instance Agent Version
KargoService_UpdateInstanceAgentVersion_1 3 params body → 200401403404default
DELETE
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/{instance_id}/agents/{id}
Delete Instance Agent
KargoService_DeleteInstanceAgent_1 4 params → 200401403404default
GET
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/{instance_id}/agents/{id}
Get Kargo Instance Agent
KargoService_GetKargoInstanceAgent_1 4 params → 200401403404default
PUT
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/{instance_id}/agents/{id}
Update Kargo Instance Agent
KargoService_UpdateKargoInstanceAgent_1 4 params body → 200401403404default
GET
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/{instance_id}/agents/{id}/command
Get Instance Agent Command
KargoService_GetInstanceAgentCommand_1 7 params → 200401403404default
GET
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/{instance_id}/agents/{id}/manifests
Get Kargo Instance Agent Manifests
KargoService_GetKargoInstanceAgentManifests_1 5 params → 200401403404default
GET
/api/v1/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/{name}
Get Kargo Instance
KargoService_GetKargoInstance_1 3 params → 200401403404default
GET
/api/v1/stream/orgs/{organization_id}/kargo/instances
Watch Kargo Instances
KargoService_WatchKargoInstances 3 params → 200401403404default
GET
/api/v1/stream/orgs/{organization_id}/kargo/instances/{instance_id}/agents
Watch Kargo Instance Agents
KargoService_WatchKargoInstanceAgents 6 params → 200401403404default
GET
/api/v1/stream/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances
Watch Kargo Instances
KargoService_WatchKargoInstances_1 3 params → 200401403404default
GET
/api/v1/stream/orgs/{organization_id}/workspaces/{workspace_id}/kargo/instances/{instance_id}/agents
Watch Kargo Instance Agents
KargoService_WatchKargoInstanceAgents_1 6 params → 200401403404default
POST
/ext-api/v1/argocd/extensions/kubevision/orgs/{organization_id}/kargo/instances/promotions-events
Get Promotion Events
KargoService_GetPromotionEvents_2 1 param body → 200401403404default
POST
/ext-api/v1/argocd/extensions/kubevision/orgs/{organization_id}/kargo/instances/promotions-stats
Get Promotion Stats
KargoService_GetPromotionStats_2 1 param body → 200401403404default
POST
/ext-api/v1/argocd/extensions/kubevision/orgs/{organization_id}/kargo/instances/stage-specific-stats
Get Stage Specific Stats
KargoService_GetStageSpecificStats_2 1 param body → 200401403404default

Schemas 86

The contract defines 86 schemas that model the data the API accepts and returns. The most detailed are akuity_kargo_v1_ApplyKargoInstanceRequest (24 properties), akuity_kargo_v1_KargoInstance (22 properties), akuity_kargo_v1_ExportKargoInstanceResponse (17 properties), akuity_kargo_v1_KargoAgentData (14 properties). Each schema is shown below with its type and property counts.

akuity_kargo_v1_CreateKargoInstanceAgentResponse
object
1 property
akuity_kargo_v1_UpdateKargoInstanceAgentRequest
object
6 properties
akuity_types_status_health_v1_AgentHealthStatus
object
3 properties
akuity_kargo_v1_KargoOidcConfig
object
12 properties
akuity_kargo_v1_OperationInitiator
object
2 properties
akuity_types_events_v1_EventType
string
akuity_kargo_v1_UpdateKargoInstanceAgentsResponse
object
akuity_types_status_health_v1_Status
object
2 properties
akuity_types_secrets_v1_SecretsManagementConfig
object
2 properties
akuity_kargo_v1_RegenerateManifestsRequest
object
5 properties
akuity_kargo_v1_PromotionEvent
object
8 properties
akuity_kargo_v1_DataDogRolloutsSecret
object
3 properties
akuity_kargo_v1_KargoApiSecret
object
1 property
akuity_kargo_v1_DeleteInstanceAgentResponse
object
akuity_types_status_health_v1_AgentAggregatedHealthResponse
object
6 properties
akuity_kargo_v1_RecoveryTimeData
object
3 properties
akuity_kargo_v1_PromotionFilter
object
8 properties
akuity_kargo_v1_GetInstanceAgentCommandResponse
object
1 property
akuity_kargo_v1_PatchKargoInstanceResponse
object
1 property
akuity_kargo_v1_GetStageSpecificStatsResponse
object
2 properties
akuity_kargo_v1_UpdateKargoInstanceAgentResponse
object
1 property
akuity_kargo_v1_KargoIPAllowListEntry
object
2 properties
akuity_kargo_v1_PruneResourceType
string
akuity_kargo_v1_KargoOidcConfig_Value
object
1 property
akuity_kargo_v1_CertificateStatus
object
4 properties
akuity_types_status_health_v1_TenantPhase
string
akuity_types_status_health_v1_StatusCode
string
akuity_kargo_v1_GetStageSpecificStatsRequest
object
3 properties
akuity_kargo_v1_KargoInstanceSpec
object
10 properties
akuity_types_misc_v1_GroupByInterval
string
akuity_kargo_v1_InfluxDbRolloutsSecret
object
3 properties
akuity_kargo_v1_SetAgentMaintenanceModeResponse
object
akuity_kargo_v1_KargoWebhookCM
object
akuity_kargo_v1_AkuityIntelligence
object
5 properties
akuity_kargo_v1_ExportKargoInstanceResponse
object
17 properties
akuity_kargo_v1_KargoApiCM
object
2 properties
akuity_kargo_v1_PromotionEventDetails
object
11 properties
akuity_kargo_v1_DeleteInstanceResponse
object
akuity_kargo_v1_UpdateKargoInstanceWorkspaceResponse
object
1 property
akuity_kargo_v1_PromotionGroupField
string
akuity_kargo_v1_CreateKargoInstanceResponse
object
1 property
akuity_types_secrets_v1_ClusterSecretMapping
object
2 properties
akuity_kargo_v1_WatchKargoInstancesResponse
object
2 properties
akuity_kargo_v1_KargoInstance
object
22 properties
akuity_kargo_v1_UpdateKargoInstanceWorkspaceRequest
object
4 properties
akuity_kargo_v1_PromotionField
string
akuity_kargo_v1_GetPromotionStatsRequest
object
5 properties
akuity_kargo_v1_UpdateInstanceAgentVersionRequest
object
6 properties
akuity_kargo_v1_KargoAgentState
object
7 properties
akuity_kargo_v1_KargoPredefinedAccountData
object
4 properties
akuity_kargo_v1_RegenerateManifestsResponse
object
1 property
akuity_kargo_v1_GetKargoInstanceAgentResponse
object
1 property
akuity_kargo_v1_KargoPredefinedAccountClaimValue
object
1 property
akuity_types_secrets_v1_LabelSelectorRequirement
object
3 properties
akuity_kargo_v1_GetPromotionStatsResponse
object
1 property
akuity_kargo_v1_KargoControllerCM
object
akuity_kargo_v1_KargoMiscellaneousSecrets
object
3 properties
akuity_kargo_v1_ListKargoInstancesResponse
object
1 property
akuity_kargo_v1_RotateInstanceAgentCredentialsResponse
object
1 property
akuity_kargo_v1_NewRelicRolloutsSecret
object
5 properties
akuity_kargo_v1_RotateInstanceAgentCredentialsRequest
object
5 properties
akuity_kargo_v1_KargoAgentSize
string
akuity_types_id_v1_Type
string
akuity_types_status_reconciliation_v1_AgentUpdateStatus
string
akuity_types_status_reconciliation_v1_Status
object
2 properties
akuity_kargo_v1_GetPromotionEventsRequest
object
7 properties
akuity_kargo_v1_KargoAgentData
object
14 properties
akuity_kargo_v1_CreateKargoInstanceAgentRequest
object
8 properties
akuity_types_status_reconciliation_v1_StatusCode
string
akuity_kargo_v1_WatchKargoInstanceAgentsResponse
object
2 properties
akuity_kargo_v1_UpdateKargoInstanceAgentsRequest
object
4 properties
akuity_kargo_v1_UpdateInstanceAgentVersionResponse
object
akuity_kargo_v1_SetAgentMaintenanceModeRequest
object
7 properties
akuity_kargo_v1_GarbageCollectorConfig
object
4 properties
akuity_kargo_v1_LeadTimeData
object
4 properties
akuity_types_secrets_v1_ObjectSelector
object
2 properties
akuity_kargo_v1_GetPromotionEventsResponse
object
3 properties
akuity_kargo_v1_ListKargoInstanceAgentsResponse
object
2 properties
akuity_kargo_v1_ApplyKargoInstanceResponse
object
akuity_kargo_v1_ApplyKargoInstanceRequest
object
24 properties
Status
object
3 properties
akuity_kargo_v1_GetKargoInstanceResponse
object
1 property
akuity_kargo_v1_PromotionStat
object
3 properties
akuity_kargo_v1_KargoAgentCustomization
object
2 properties
akuity_kargo_v1_KargoAgent
object
11 properties
akuity_kargo_v1_CreateKargoInstanceRequest
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

akuity-kargoservice-api-openapi.yml Raw ↑

Other APIs Akuity publishes across the network.

Akuity API Key Service API
Akuity Argo CD Service API
Akuity Auth Service API
Akuity Custom Role Service API
Akuity Extension Service API
Akuity Organization Service API
Akuity System Service API
Where this information came from

This is an independent, third-party profile of Akuity Kargo Service 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.