Akuity · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Akuity Platform API — Argo CD Argo CD Service API
156 actions
156 updates
phrasing
extends
openapi/akuity-argocdservice-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Akuity's API. It is a proposal applied on top of the contract, not a document Akuity publishes.
What the actions change
x-apievangelist-phrasing
Targets 156 · first 16 shown; the file carries all of them
$.info
$.paths['/api/v1/argocd/versions'].get
$.paths['/api/v1/orgs/{organization_id}/argocd/instances'].get
$.paths['/api/v1/orgs/{organization_id}/argocd/instances'].post
$.paths['/api/v1/orgs/{organization_id}/argocd/instances/ai-assistant-usage-stats'].post
$.paths['/api/v1/orgs/{organization_id}/argocd/instances/sync-operations-events'].post
$.paths['/api/v1/orgs/{organization_id}/argocd/instances/sync-operations-stats'].post
$.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}'].get
$.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}'].put
$.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}'].delete
$.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}'].patch
$.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/apply'].post
$.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/appset/secret'].get
$.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/appset/secret'].patch
$.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/clusters'].put
$.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/config-management-plugins'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Akuity Platform API — Argo CD Argo CD Service API
version: 1.0.0
extends: openapi/akuity-argocdservice-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 155
- target: $.paths['/api/v1/argocd/versions'].get
update:
x-apievangelist-phrasing:
intent: List available Argo CD versions
effect: read
questions:
- Which Argo CD versions can I run on a managed Akuity instance?
- What version numbers are offered when I pick a release for a new Argo CD instance?
instructions:
- text: Show me the Argo CD versions available for managed instances.
- text: List the supported Argo CD release versions I can choose from.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances'].get
update:
x-apievangelist-phrasing:
intent: List Argo CD instances in an organization
effect: read
questions:
- How do I see every Argo CD instance my organization runs?
- Can I narrow the organization-wide instance list down to one workspace?
instructions:
- text: List all Argo CD instances in organization {org}.
slots:
org: path.organization_id
- text: Show the Argo CD instances of organization {org} that sit in workspace {ws_filter}.
slots:
org: path.organization_id
ws_filter: query.workspaceId
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances'].post
update:
x-apievangelist-phrasing:
intent: Create an Argo CD instance in an organization
effect: write
questions:
- How do I spin up a new managed Argo CD instance for my organization?
- Can I pick the Argo CD version and shard when creating an instance at the org level?
instructions:
- text: Create an Argo CD instance named {name} in organization {org}.
slots:
name: requestBody.name
org: path.organization_id
- text: Provision Argo CD instance {name} on version {version} for org {org}.
slots:
name: requestBody.name
version: requestBody.version
org: path.organization_id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/ai-assistant-usage-stats'].post
update:
x-apievangelist-phrasing:
intent: Get AI assistant usage statistics
effect: read
questions:
- How much has the AI assistant been used on my Argo CD instances?
- Can I see AI assistant usage for just one instance?
instructions:
- text: Get AI assistant usage stats for organization {org}.
slots:
org: path.organization_id
- text: Show AI assistant usage for instance {instance} in org {org}.
slots:
instance: requestBody.instanceId
org: path.organization_id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/sync-operations-events'].post
update:
x-apievangelist-phrasing:
intent: Query sync operation events
effect: read
questions:
- Where can I find the history of sync operations across my Argo CD instances?
- Can I page through sync events with a limit and offset and a filter?
instructions:
- text: Fetch sync operation events for organization {org}.
slots:
org: path.organization_id
- text: Pull the first {limit} sync operation events for org {org} matching filter {filter}.
slots:
limit: requestBody.limit
org: path.organization_id
filter: requestBody.filter
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/sync-operations-stats'].post
update:
x-apievangelist-phrasing:
intent: Get aggregated sync operation statistics
effect: read
questions:
- How many sync operations succeeded or failed over time in my organization?
- Can sync stats be grouped by a field or a label and bucketed by interval?
instructions:
- text: Get sync operation statistics for organization {org}.
slots:
org: path.organization_id
- text: Chart sync stats for org {org} grouped by {group_by} per {interval}.
slots:
org: path.organization_id
group_by: requestBody.groupByField
interval: requestBody.interval
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get an Argo CD instance in an organization
effect: read
questions:
- How do I look up the details of one Argo CD instance in my org?
- Can I fetch an instance by its name rather than its ID?
instructions:
- text: Get Argo CD instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Look up instance {instance} of org {org} using id type {id_type}.
slots:
instance: path.id
org: path.organization_id
id_type: query.idType
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update an Argo CD instance in an organization
effect: write
questions:
- How do I replace the full settings of an org-level Argo CD instance?
- What happens when I PUT a new instance definition over an existing one?
instructions:
- text: Update Argo CD instance {instance} in organization {org} with a new definition.
slots:
instance: path.id
org: path.organization_id
- text: Overwrite the configuration of org {org} instance {instance}.
slots:
org: path.organization_id
instance: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an Argo CD instance from an organization
effect: destructive
questions:
- How do I tear down an Argo CD instance my organization no longer needs?
- Is deleting an org-level instance permanent?
instructions:
- text: Delete Argo CD instance {instance} from organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Remove org {org} instance {instance} that lives in workspace {ws_filter}.
slots:
org: path.organization_id
instance: path.id
ws_filter: query.workspaceId
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}'].patch
update:
x-apievangelist-phrasing:
intent: Partially update an Argo CD instance in an org
effect: write
questions:
- Can I change just a few fields on an org-level Argo CD instance without resending all of it?
- How do I patch an instance addressed only by organization?
instructions:
- text: Patch a few settings on Argo CD instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Apply a partial change to org {org} instance {instance}.
slots:
org: path.organization_id
instance: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/apply'].post
update:
x-apievangelist-phrasing:
intent: Declaratively apply config to an org instance
effect: write
questions:
- How do I push applications, projects and clusters to an Argo CD instance in one declarative apply?
- Can an apply prune clusters or repo credentials that are no longer in my manifest?
instructions:
- text: Apply my declarative manifests to Argo CD instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Apply config to org {org} instance {instance} and prune clusters missing from it ({prune}).
slots:
org: path.organization_id
instance: path.id
prune: requestBody.pruneClusters
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/appset/secret'].get
update:
x-apievangelist-phrasing:
intent: Get an org instance's ApplicationSet secret
effect: read
questions:
- Where can I read the ApplicationSet secret of an Argo CD instance in my org?
- Which keys are stored in the appset secret today?
instructions:
- text: Show the ApplicationSet secret for instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Read the appset secret keys of org {org} instance {instance}.
slots:
org: path.organization_id
instance: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/appset/secret'].patch
update:
x-apievangelist-phrasing:
intent: Update an org instance's ApplicationSet secret
effect: write
questions:
- How do I add a token to the ApplicationSet secret for an org-level instance?
- Can I change only some appset secret keys?
instructions:
- text: Patch the ApplicationSet secret of instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Set new appset secret values {secret} on org {org} instance {instance}.
slots:
secret: requestBody.secret
org: path.organization_id
instance: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/clusters'].put
update:
x-apievangelist-phrasing:
intent: Update cluster customizations for an org instance
effect: write
questions:
- How do I change the cluster customization defaults for an Argo CD instance in my org?
- Can I turn on the multi-cluster Kubernetes dashboard for an instance?
instructions:
- text: Update cluster customizations on instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Set multi-cluster dashboard to {enabled} for org {org} instance {instance}.
slots:
enabled: requestBody.multiClusterK8sDashboardEnabled
org: path.organization_id
instance: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/config-management-plugins'].get
update:
x-apievangelist-phrasing:
intent: Get config management plugins of an org instance
effect: read
questions:
- Which config management plugins are set up on my org's Argo CD instance?
- How can I review the CMP definitions an instance uses?
instructions:
- text: List config management plugins for instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Show the CMP setup of org {org} instance {instance}.
slots:
org: path.organization_id
instance: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/config-management-plugins'].put
update:
x-apievangelist-phrasing:
intent: Replace config management plugins on an org instance
effect: write
questions:
- How do I register a new config management plugin on an org-level instance?
- Does updating CMPs replace the whole plugin list?
instructions:
- text: Replace the config management plugins on instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Save plugin definitions {plugins} to org {org} instance {instance}.
slots:
plugins: requestBody.plugins
org: path.organization_id
instance: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/css'].get
update:
x-apievangelist-phrasing:
intent: Get custom UI CSS of an org instance
effect: read
questions:
- What custom CSS is styling the Argo CD UI of my org's instance?
- Can I read back the theme overrides applied to an instance?
instructions:
- text: Show the custom CSS for instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Fetch UI stylesheet overrides of org {org} instance {instance}.
slots:
org: path.organization_id
instance: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/css'].put
update:
x-apievangelist-phrasing:
intent: Set custom UI CSS on an org instance
effect: write
questions:
- How do I rebrand the Argo CD web UI of an org-level instance with my own CSS?
- Can custom styles be pushed without touching other settings?
instructions:
- text: Set custom CSS {css} on instance {instance} in organization {org}.
slots:
css: requestBody.css
instance: path.id
org: path.organization_id
- text: Replace the UI stylesheet of org {org} instance {instance}.
slots:
org: path.organization_id
instance: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/export'].get
update:
x-apievangelist-phrasing:
intent: Export an org instance's declarative config
effect: read
questions:
- How do I dump an Argo CD instance's configuration so I can keep it in Git?
- Can I export an instance identified by name at the org level?
instructions:
- text: Export the declarative configuration of instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Download a config export of org {org} instance {instance} looked up by {id_type}.
slots:
org: path.organization_id
instance: path.id
id_type: query.idType
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/image-updater'].get
update:
x-apievangelist-phrasing:
intent: Get Image Updater settings of an org instance
effect: read
questions:
- What is the Argo CD Image Updater configured to do on my org's instance?
- Where do I check Image Updater config, SSH config and secret keys together?
instructions:
- text: Show the Image Updater settings for instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Get image updater config for org {org} instance {instance}.
slots:
org: path.organization_id
instance: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/image-updater/config'].put
update:
x-apievangelist-phrasing:
intent: Update Image Updater config on an org instance
effect: write
questions:
- How do I change registries or settings for the Image Updater on an org-level instance?
- Can I pin the Image Updater to a specific version?
instructions:
- text: Update the Image Updater config on instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Set Image Updater version {version} for org {org} instance {instance}.
slots:
version: requestBody.version
org: path.organization_id
instance: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/image-updater/secret'].patch
update:
x-apievangelist-phrasing:
intent: Update Image Updater secret on an org instance
effect: write
questions:
- How do I give the Image Updater registry credentials on my org's instance?
- Can I rotate one Image Updater secret key without clearing the rest?
instructions:
- text: Patch the Image Updater secret on instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Store registry credentials {secret} in the image updater secret of org {org} instance {instance}.
slots:
secret: requestBody.secret
org: path.organization_id
instance: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/image-updater/ssh-config'].put
update:
x-apievangelist-phrasing:
intent: Update Image Updater SSH config on an org instance
effect: write
questions:
- How do I set the SSH config the Image Updater uses for Git write-back in my org?
- Can the Image Updater SSH settings be replaced on their own?
instructions:
- text: Replace the SSH known-hosts and keys config used by Image Updater on instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Replace image updater ssh_config for org {org} instance {instance} with {config}.
slots:
org: path.organization_id
instance: path.id
config: requestBody.config
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/notifications'].get
update:
x-apievangelist-phrasing:
intent: Get notification settings of an org instance
effect: read
questions:
- What notification triggers and templates are configured on my org's Argo CD instance?
- How can I see which notification secret keys exist for an instance?
instructions:
- text: Show notification settings for instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Get the notifications config of org {org} instance {instance}.
slots:
org: path.organization_id
instance: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/notifications'].put
update:
x-apievangelist-phrasing:
intent: Update notification config on an org instance
effect: write
questions:
- How do I add a new notification trigger to an org-level Argo CD instance?
- Does updating notification config overwrite existing templates?
instructions:
- text: Update the notification config on instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Replace notification triggers and templates of org {org} instance {instance} with {config}.
slots:
org: path.organization_id
instance: path.id
config: requestBody.config
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/notifications/catalog'].get
update:
x-apievangelist-phrasing:
intent: Browse the notification catalog of an org instance
effect: read
questions:
- Which ready-made notification triggers and templates can I enable on my org's instance?
- Is there a catalog of built-in notification templates?
instructions:
- text: Show the notification catalog for instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: List built-in notification templates available to org {org} instance {instance}.
slots:
org: path.organization_id
instance: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/notifications/secret'].patch
update:
x-apievangelist-phrasing:
intent: Update notification secret on an org instance
effect: write
questions:
- How do I store a webhook token for notifications on my org-level instance?
- Can I update one notification secret key at a time?
instructions:
- text: Patch the notification secret on instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Add notification credentials {secret} to org {org} instance {instance}.
slots:
secret: requestBody.secret
org: path.organization_id
instance: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/resource-customizations'].get
update:
x-apievangelist-phrasing:
intent: Get resource customizations of an org instance
effect: read
questions:
- What custom health checks and actions are defined for resources on my org's instance?
- Is ignoring resource updates turned on for an instance?
instructions:
- text: Show resource customizations for instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Get the resource health and ignore rules of org {org} instance {instance}.
slots:
org: path.organization_id
instance: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/resource-customizations'].put
update:
x-apievangelist-phrasing:
intent: Update resource customizations on an org instance
effect: write
questions:
- How do I define a custom health check for a CRD on an org-level instance?
- Can I turn on ignoring resource updates when saving customizations?
instructions:
- text: Update resource customizations on instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Save resource rules {resources} to org {org} instance {instance}.
slots:
resources: requestBody.resources
org: path.organization_id
instance: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/secret'].patch
update:
x-apievangelist-phrasing:
intent: Update the main Argo CD secret of an org instance
effect: write
questions:
- How do I set keys in the argocd-secret for my org-level instance?
- Can I change one Argo CD secret key without rewriting all of them?
instructions:
- text: Patch the argocd-secret on instance {instance} in organization {org}.
slots:
instance: path.id
org: path.organization_id
- text: Write secret values {secret} into the core Argo CD secret of org {org} instance {instance}.
slots:
secret: requestBody.secret
org: path.organization_id
instance: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{id}/transfer'].put
update:
x-apievangelist-phrasing:
intent: Move an org instance to another workspace
effect: write
questions:
- How do I transfer an Argo CD instance into a different workspace?
- Can an instance change workspace without being recreated?
instructions:
- text: Move instance {instance} in organization {org} to workspace {new_ws}.
slots:
instance: path.id
org: path.organization_id
new_ws: requestBody.newWorkspaceId
- text: Transfer org {org} instance {instance} into workspace {new_ws}.
slots:
org: path.organization_id
instance: path.id
new_ws: requestBody.newWorkspaceId
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{instance_id}/accounts'].get
update:
x-apievangelist-phrasing:
intent: List local accounts on an org instance
effect: read
questions:
- Which local Argo CD accounts exist on my org-level instance?
- How can I check which accounts are disabled?
instructions:
- text: List local accounts on instance {instance} in organization {org}.
slots:
instance: path.instance_id
org: path.organization_id
- text: Show every Argo CD user account of org {org} instance {instance}.
slots:
org: path.organization_id
instance: path.instance_id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{instance_id}/accounts/{name}'].put
update:
x-apievangelist-phrasing:
intent: Create or update a local account on an org instance
effect: write
questions:
- How do I add a local Argo CD account with API key capability in my org's instance?
- Can I disable an existing local account instead of deleting it?
instructions:
- text: Create or update account {account} on instance {instance} in organization {org}.
slots:
account: path.name
instance: path.instance_id
org: path.organization_id
- text: Set account {account} on org {org} instance {instance} to disabled={disabled}.
slots:
account: path.name
org: path.organization_id
instance: path.instance_id
disabled: requestBody.disabled
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{instance_id}/accounts/{name}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a local account from an org instance
effect: destructive
questions:
- How do I remove a local Argo CD user from my org-level instance?
- Is removing an account from an instance reversible?
instructions:
- text: Delete account {account} from instance {instance} in organization {org}.
slots:
account: path.name
instance: path.instance_id
org: path.organization_id
- text: Remove user {account} of org {org} instance {instance}.
slots:
account: path.name
org: path.organization_id
instance: path.instance_id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{instance_id}/accounts/{name}/password'].put
update:
x-apievangelist-phrasing:
intent: Set a local account's password on an org instance
effect: write
questions:
- How do I set a specific password for a local account on my org's instance?
- Can I choose the new password myself?
instructions:
- text: Set password {password} for account {account} on instance {instance} in organization {org}.
slots:
password: requestBody.password
account: path.name
instance: path.instance_id
org: path.organization_id
- text: Change the login password of user {account} in org {org} instance {instance}.
slots:
account: path.name
org: path.organization_id
instance: path.instance_id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{instance_id}/accounts/{name}/regenerate-password'].post
update:
x-apievangelist-phrasing:
intent: Regenerate a local account password on an org instance
effect: write
questions:
- Can I have a fresh random password generated for a local account on my org's instance?
- How do I reset a forgotten local admin password?
instructions:
- text: Regenerate the password for account {account} on instance {instance} in organization {org}.
slots:
account: path.name
instance: path.instance_id
org: path.organization_id
- text: Generate a new random password for user {account} of org {org} instance {instance}.
slots:
account: path.name
org: path.organization_id
instance: path.instance_id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{instance_id}/clusters'].get
update:
x-apievangelist-phrasing:
intent: List clusters connected to an org instance
effect: read
questions:
- Which Kubernetes clusters are attached to my org's Argo CD instance?
- How do I see all managed clusters for an instance?
instructions:
- text: List clusters connected to instance {instance} in organization {org}.
slots:
instance: path.instance_id
org: path.organization_id
- text: Show managed Kubernetes clusters of org {org} instance {instance}.
slots:
org: path.organization_id
instance: path.instance_id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{instance_id}/clusters'].post
update:
x-apievangelist-phrasing:
intent: Connect a cluster to an org instance
effect: write
questions:
- How do I register a new Kubernetes cluster with my org-level Argo CD instance?
- Can a cluster be added as namespace-scoped only?
instructions:
- text: Add cluster {cluster_name} to instance {instance} in organization {org}.
slots:
cluster_name: requestBody.name
instance: path.instance_id
org: path.organization_id
- text: Register cluster {cluster_name} in namespace {namespace} with org {org} instance {instance}.
slots:
cluster_name: requestBody.name
namespace: requestBody.namespace
org: path.organization_id
instance: path.instance_id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/orgs/{organization_id}/argocd/instances/{instance_id}/clusters/agent-version'].post
update:
x-apievangelist-phrasing:
intent: Upgrade the agent version on org instance clusters
effect: write
questions:
- How do I roll out a new Akuity agent version to clusters of my org's instance?
- Can I upgrade every cluster's agent at once instead of listing names?
instructions:
- text: Upgrade agents on clusters {clusters} of instance {instance} in organization {org} to {new_version}.
slots:
clusters: requestBody.clusterNames
instance: path.instance_id
org: path.organization_id
new_version: requestBody.newVersion
- text: Bump every cluster agent in org {org} instance {instance} to version {new_version}.
slots:
org: path.organization_id
instance: path.instance_id
new_version: requestBody.newVersion
method: generated
generated: '2026-09-26'
# --- truncated at 32 KB (139 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/akuity/refs/heads/main/overlays/akuity-argocdservice-api-phrasing-overlay.yaml