Argo CD ApplicationSetService API
The ApplicationSetService API from Argo CD — 6 operation(s) for applicationsetservice.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/argocd-applicationsetservice-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: Description of all APIs
title: Consolidate Services AccountService Application Set Service API
version: version not set
tags:
- name: ApplicationSetService
paths:
/api/v1/applicationsets:
get:
tags:
- ApplicationSetService
summary: List returns list of applicationset
operationId: ApplicationSetService_List
parameters:
- description: the project names to restrict returned list applicationsets.
name: projects
in: query
style: form
explode: true
schema:
type: array
items:
type: string
- description: the selector to restrict returned list to applications only with matched labels.
name: selector
in: query
schema:
type: string
- description: The application set namespace. Default empty is argocd control plane namespace.
name: appsetNamespace
in: query
schema:
type: string
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/v1alpha1ApplicationSetList'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
post:
tags:
- ApplicationSetService
summary: Create creates an applicationset
operationId: ApplicationSetService_Create
parameters:
- name: upsert
in: query
schema:
type: boolean
- name: dryRun
in: query
schema:
type: boolean
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/v1alpha1ApplicationSet'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/v1alpha1ApplicationSet'
required: true
/api/v1/applicationsets/generate:
post:
tags:
- ApplicationSetService
summary: Generate generates
operationId: ApplicationSetService_Generate
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/applicationsetApplicationSetGenerateResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/applicationsetApplicationSetGenerateRequest'
required: true
/api/v1/applicationsets/{name}:
get:
tags:
- ApplicationSetService
summary: Get returns an applicationset by name
operationId: ApplicationSetService_Get
parameters:
- description: the applicationsets's name
name: name
in: path
required: true
schema:
type: string
- description: The application set namespace. Default empty is argocd control plane namespace.
name: appsetNamespace
in: query
schema:
type: string
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/v1alpha1ApplicationSet'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
delete:
tags:
- ApplicationSetService
summary: Delete deletes an application set
operationId: ApplicationSetService_Delete
parameters:
- name: name
in: path
required: true
schema:
type: string
- description: The application set namespace. Default empty is argocd control plane namespace.
name: appsetNamespace
in: query
schema:
type: string
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/applicationsetApplicationSetResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
/api/v1/applicationsets/{name}/events:
get:
tags:
- ApplicationSetService
summary: ListResourceEvents returns a list of event resources
operationId: ApplicationSetService_ListResourceEvents
parameters:
- description: the applicationsets's name
name: name
in: path
required: true
schema:
type: string
- description: The application set namespace. Default empty is argocd control plane namespace.
name: appsetNamespace
in: query
schema:
type: string
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/v1EventList'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
/api/v1/applicationsets/{name}/resource-tree:
get:
tags:
- ApplicationSetService
summary: ResourceTree returns resource tree
operationId: ApplicationSetService_ResourceTree
parameters:
- name: name
in: path
required: true
schema:
type: string
- description: The application set namespace. Default empty is argocd control plane namespace.
name: appsetNamespace
in: query
schema:
type: string
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/v1alpha1ApplicationSetTree'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
/api/v1/stream/applicationsets:
get:
tags:
- ApplicationSetService
operationId: ApplicationSetService_Watch
parameters:
- name: name
in: query
schema:
type: string
- name: projects
in: query
style: form
explode: true
schema:
type: array
items:
type: string
- name: selector
in: query
schema:
type: string
- name: appSetNamespace
in: query
schema:
type: string
- description: when specified with a watch call, shows changes that occur after that particular version of a resource.
name: resourceVersion
in: query
schema:
type: string
responses:
'200':
description: A successful response.(streaming responses)
content:
application/json:
schema:
type: object
title: Stream result of v1alpha1ApplicationSetWatchEvent
properties:
error:
$ref: '#/components/schemas/runtimeStreamError'
result:
$ref: '#/components/schemas/v1alpha1ApplicationSetWatchEvent'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
components:
schemas:
v1alpha1KustomizeReplica:
type: object
properties:
count:
$ref: '#/components/schemas/intstrIntOrString'
name:
type: string
title: Name of Deployment or StatefulSet
v1alpha1SCMProviderGeneratorBitbucketServer:
description: SCMProviderGeneratorBitbucketServer defines connection info specific to Bitbucket Server.
type: object
properties:
allBranches:
description: Scan all branches instead of just the default branch.
type: boolean
api:
description: The Bitbucket Server REST API URL to talk to. Required.
type: string
basicAuth:
$ref: '#/components/schemas/v1alpha1BasicAuthBitbucketServer'
bearerToken:
$ref: '#/components/schemas/v1alpha1BearerTokenBitbucket'
caRef:
$ref: '#/components/schemas/v1alpha1ConfigMapKeyRef'
insecure:
type: boolean
title: 'Allow self-signed TLS / Certificates; default: false'
project:
description: Project to scan. Required.
type: string
v1alpha1ComparedTo:
type: object
title: ComparedTo contains application source and target which was used for resources comparison
properties:
destination:
$ref: '#/components/schemas/v1alpha1ApplicationDestination'
ignoreDifferences:
type: array
title: IgnoreDifferences is a reference to the application's ignored differences used for comparison
items:
$ref: '#/components/schemas/v1alpha1ResourceIgnoreDifferences'
source:
$ref: '#/components/schemas/v1alpha1ApplicationSource'
sources:
type: array
title: Sources is a reference to the application's multiple sources used for comparison
items:
$ref: '#/components/schemas/v1alpha1ApplicationSource'
v1FieldsV1:
description: 'FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.
Each key is either a ''.'' representing the field itself, and will always map to an empty set,
or a string representing a sub-field or item. The string will follow one of these four formats:
''f:<name>'', where <name> is the name of a field in a struct, or key in a map
''v:<value>'', where <value> is the exact json formatted value of a list item
''i:<index>'', where <index> is position of a item in a list
''k:<keys>'', where <keys> is a map of a list item''s key fields to their unique values
If a key maps to an empty Fields value, the field that key represents is part of the set.
The exact format is defined in sigs.k8s.io/structured-merge-diff
+protobuf.options.(gogoproto.goproto_stringer)=false'
type: object
properties:
Raw:
description: Raw is the underlying serialization of this object.
type: string
format: byte
v1alpha1ApplicationSpec:
description: ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
type: object
properties:
destination:
$ref: '#/components/schemas/v1alpha1ApplicationDestination'
ignoreDifferences:
type: array
title: IgnoreDifferences is a list of resources and their fields which should be ignored during comparison
items:
$ref: '#/components/schemas/v1alpha1ResourceIgnoreDifferences'
info:
type: array
title: Info contains a list of information (URLs, email addresses, and plain text) that relates to the application
items:
$ref: '#/components/schemas/v1alpha1Info'
project:
description: 'Project is a reference to the project this application belongs to.
The empty string means that application belongs to the ''default'' project.'
type: string
revisionHistoryLimit:
description: 'RevisionHistoryLimit limits the number of items kept in the application''s revision history, which is used for informational purposes as well as for rollbacks to previous versions.
This should only be changed in exceptional circumstances.
Setting to zero will store no history. This will reduce storage used.
Increasing will increase the space used to store the history, so we do not recommend increasing it.
Default is 10.'
type: integer
format: int64
source:
$ref: '#/components/schemas/v1alpha1ApplicationSource'
sourceHydrator:
$ref: '#/components/schemas/v1alpha1SourceHydrator'
sources:
type: array
title: Sources is a reference to the location of the application's manifests or chart
items:
$ref: '#/components/schemas/v1alpha1ApplicationSource'
syncPolicy:
$ref: '#/components/schemas/v1alpha1SyncPolicy'
v1ObjectMeta:
description: 'ObjectMeta is metadata that all persisted resources must have, which includes all objects
users must create.'
type: object
properties:
annotations:
type: object
title: 'Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
+optional'
additionalProperties:
type: string
creationTimestamp:
$ref: '#/components/schemas/v1Time'
deletionGracePeriodSeconds:
type: integer
format: int64
title: 'Number of seconds allowed for this object to gracefully terminate before
it will be removed from the system. Only set when deletionTimestamp is also set.
May only be shortened.
Read-only.
+optional'
deletionTimestamp:
$ref: '#/components/schemas/v1Time'
finalizers:
type: array
title: 'Must be empty before the object is deleted from the registry. Each entry
is an identifier for the responsible component that will remove the entry
from the list. If the deletionTimestamp of the object is non-nil, entries
in this list can only be removed.
Finalizers may be processed and removed in any order. Order is NOT enforced
because it introduces significant risk of stuck finalizers.
finalizers is a shared field, any actor with permission can reorder it.
If the finalizer list is processed in order, then this can lead to a situation
in which the component responsible for the first finalizer in the list is
waiting for a signal (field value, external system, or other) produced by a
component responsible for a finalizer later in the list, resulting in a deadlock.
Without enforced ordering finalizers are free to order amongst themselves and
are not vulnerable to ordering changes in the list.
+optional
+patchStrategy=merge
+listType=set'
items:
type: string
generateName:
description: 'GenerateName is an optional prefix, used by the server, to generate a unique
name ONLY IF the Name field has not been provided.
If this field is used, the name returned to the client will be different
than the name passed. This value will also be combined with a unique suffix.
The provided value has the same validation rules as the Name field,
and may be truncated by the length of the suffix required to make the value
unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
+optional'
type: string
generation:
type: integer
format: int64
title: 'A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
+optional'
labels:
type: object
title: 'Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
+optional'
additionalProperties:
type: string
managedFields:
description: 'ManagedFields maps workflow-id and version to the set of fields
that are managed by that workflow. This is mostly for internal
housekeeping, and users typically shouldn''t need to set or
understand this field. A workflow can be the user''s name, a
controller''s name, or the name of a specific apply path like
"ci-cd". The set of fields is always in the version that the
workflow used when modifying the object.
+optional
+listType=atomic'
type: array
items:
$ref: '#/components/schemas/v1ManagedFieldsEntry'
name:
type: string
title: 'Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
+optional'
namespace:
description: 'Namespace defines the space within which each name must be unique. An empty namespace is
equivalent to the "default" namespace, but "default" is the canonical representation.
Not all objects are required to be scoped to a namespace - the value of this field for
those objects will be empty.
Must be a DNS_LABEL.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
+optional'
type: string
ownerReferences:
type: array
title: 'List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller,
then an entry in this list will point to this controller, with the controller field set to true.
There cannot be more than one managing controller.
+optional
+patchMergeKey=uid
+patchStrategy=merge
+listType=map
+listMapKey=uid'
items:
$ref: '#/components/schemas/v1OwnerReference'
resourceVersion:
description: 'An opaque value that represents the internal version of this object that can
be used by clients to determine when objects have changed. May be used for optimistic
concurrency, change detection, and the watch operation on a resource or set of resources.
Clients must treat these values as opaque and passed unmodified back to the server.
They may only be valid for a particular resource or set of resources.
Populated by the system.
Read-only.
Value must be treated as opaque by clients and .
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+optional'
type: string
selfLink:
type: string
title: 'Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
+optional'
uid:
description: 'UID is the unique in time and space value for this object. It is typically generated by
the server on successful creation of a resource and is not allowed to change on PUT
operations.
Populated by the system.
Read-only.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
+optional'
type: string
v1alpha1PluginGenerator:
description: PluginGenerator defines connection info specific to Plugin.
type: object
properties:
configMapRef:
$ref: '#/components/schemas/v1alpha1PluginConfigMapRef'
input:
$ref: '#/components/schemas/v1alpha1PluginInput'
requeueAfterSeconds:
description: RequeueAfterSeconds determines how long the ApplicationSet controller will wait before reconciling the ApplicationSet again.
type: integer
format: int64
template:
$ref: '#/components/schemas/v1alpha1ApplicationSetTemplate'
values:
description: 'Values contains key/value pairs which are passed directly as parameters to the template. These values will not be
sent as parameters to the plugin.'
type: object
additionalProperties:
type: string
v1alpha1ClusterGenerator:
description: ClusterGenerator defines a generator to match against clusters registered with ArgoCD.
type: object
properties:
flatList:
type: boolean
title: returns the clusters a single 'clusters' value in the template
selector:
$ref: '#/components/schemas/v1LabelSelector'
template:
$ref: '#/components/schemas/v1alpha1ApplicationSetTemplate'
values:
type: object
title: Values contains key/value pairs which are passed directly as parameters to the template
additionalProperties:
type: string
v1alpha1ApplicationSetStrategy:
description: ApplicationSetStrategy configures how generated Applications are updated in sequence.
type: object
properties:
deletionOrder:
type: string
title: 'DeletionOrder allows specifying the order for deleting generated apps when progressive sync is enabled.
accepts values "AllAtOnce" and "Reverse"'
rollingSync:
$ref: '#/components/schemas/v1alpha1ApplicationSetRolloutStrategy'
type:
type: string
v1alpha1ApplicationSourceDirectory:
type: object
title: ApplicationSourceDirectory holds options for applications of type plain YAML or Jsonnet
properties:
exclude:
type: string
title: Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
include:
type: string
title: Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnet:
$ref: '#/components/schemas/v1alpha1ApplicationSourceJsonnet'
recurse:
type: boolean
title: Recurse specifies whether to scan a directory recursively for manifests
applicationv1alpha1EnvEntry:
type: object
title: EnvEntry represents an entry in the application's environment
properties:
name:
type: string
title: Name is the name of the variable, usually expressed in uppercase
value:
type: string
title: Value is the value of the variable
v1alpha1SCMProviderGeneratorFilter:
description: 'SCMProviderGeneratorFilter is a single repository filter.
If multiple filter types are set on a single struct, they will be AND''d together. All filters must
pass for a repo to be included.'
type: object
properties:
branchMatch:
description: A regex which must match the branch name.
type: string
labelMatch:
description: A regex which must match at least one label.
type: string
pathsDoNotExist:
description: An array of paths, all of which must not exist.
type: array
items:
type: string
pathsExist:
description: An array of paths, all of which must exist.
type: array
items:
type: string
repositoryMatch:
description: A regex for repo names.
type: string
v1alpha1ApplicationSourcePlugin:
type: object
title: ApplicationSourcePlugin holds options specific to config management plugins
properties:
env:
type: array
items:
$ref: '#/components/schemas/applicationv1alpha1EnvEntry'
name:
type: string
parameters:
type: array
items:
$ref: '#/components/schemas/v1alpha1ApplicationSourcePluginParameter'
v1alpha1SyncStrategyHook:
description: 'SyncStrategyHook will perform a sync using hooks annotations.
If no hook annotation is specified falls back to `kubectl apply`.'
type: object
properties:
syncStrategyApply:
$ref: '#/components/schemas/v1alpha1SyncStrategyApply'
v1alpha1ApplicationPreservedFields:
type: object
properties:
annotations:
type: array
items:
type: string
labels:
type: array
items:
type: string
v1alpha1GitDirectoryGeneratorItem:
type: object
properties:
exclude:
type: boolean
path:
type: string
v1alpha1BearerTokenBitbucket:
description: BearerTokenBitbucket defines the Bearer token for BitBucket AppToken auth.
type: object
properties:
tokenRef:
$ref: '#/components/schemas/v1alpha1SecretRef'
v1alpha1ResourceResult:
type: object
title: ResourceResult holds the operation result details of a specific resource
properties:
group:
type: string
title: Group specifies the API group of the resource
hookPhase:
description: 'HookPhase contains the state of any operation associated with this resource OR hook
This can also contain values for non-hook resources.'
type: string
hookType:
type: string
title: HookType specifies the type of the hook. Empty for non-hook resources
images:
type: array
title: Images contains the images related to the ResourceResult
items:
type: string
kind:
type: string
title: Kind specifies the API kind of the resource
message:
type: string
title: Message contains an informational or error message for the last sync OR operation
name:
type: string
title: Name specifies the name of the resource
namespace:
type: string
title: Namespace specifies the target namespace of the resource
status:
type: string
title: Status holds the final result of the sync. Will be empty if the resources is yet to be applied/pruned and is always zero-value for hooks
syncPhase:
type: string
title: SyncPhase indicates the particular phase of the sync that this result was acquired in
version:
type: string
title: Version specifies the API version of the resource
v1Event:
description: 'Event is a report of an event somewhere in the cluster. Events
have a limited retention time and triggers and messages may evolve
with time. Event consumers should not rely on the timing of an event
with a given Reason reflecting a consistent underlying trigger, or the
continued existence of events with that Reason. Events should be
treated as informative, best-effort, supplemental data.'
type: object
properties:
action:
type: string
title: 'What action was taken/failed regarding to the Regarding object.
+optional'
count:
type: integer
format: int32
title: 'The number of times this event has occurred.
+optional'
eventTime:
$ref: '#/components/schemas/v1MicroTime'
firstTimestamp:
$ref: '#/components/schemas/v1Time'
involvedObject:
$ref: '#/components/schemas/v1ObjectReference'
lastTimestamp:
$ref: '#/components/schemas/v1Time'
message:
type: string
title: 'A human-readable description of the status of this operation.
TODO: decide on maximum length.
+optional'
metadata:
$ref: '#/components/schemas/v1ObjectMeta'
reason:
type: string
title: 'This should be a short, machine understandable string that gives the reason
for the transition into the object''s current status.
TODO: provide exact specification for format.
+optional'
related:
$ref: '#/components/schemas/v1ObjectReference'
reportingComponent:
type: string
title: 'Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`.
+optional'
reportingInstance:
type: string
title: 'ID of the controller instance, e.g. `kubelet-xyzf`.
+optional'
series:
$ref: '#/components/schemas/v1EventSeries'
source:
$ref: '#/components/schemas/v1EventSource'
type:
type: string
title: 'Type of this event (Normal, Warning), new types could be added in the future
+optional'
v1alpha1TagFilter:
type: object
properties:
key:
type: string
value:
type: string
applicationv1alpha1ResourceStatus:
description: ResourceStatus holds the current synchronization and health status of a Kubernetes resource.
type: object
properties:
group:
description: Group represents the API group of the resource (e.g., "apps" for Deployments).
type: string
health:
$ref: '#/components/schemas/v1alpha1HealthStatus'
hook:
description: Hook is true if the resource is used as a lifecycle hook in an Argo CD application.
type: boolean
kind:
description: Kind specifies the type of the resource (e.g., "Deployment", "Service").
type: string
name:
description: Name is the unique name of the resource within the namespace.
type: string
namespace:
description: Namespace defines the Kubernetes namespace where the resource is located.
type: string
requiresDeletionConfirmation:
description: RequiresDeletionConfirmation is true if the resource requires explicit user confirmation before deletion.
type: boolean
requiresPruning:
description: RequiresPruning is true if the resource needs to be pruned (deleted) as part of synchronization.
type: boolean
status:
description: Status represents the synchronization state of the resource (e.g., Synced, OutOfSync).
type: string
syncWave:
description: 'SyncWave determines the order in which resources are applied during a sync operation.
Lower values are applied first.'
type: integer
format: int64
version:
description: Version indicates the API version of the resourc
# --- truncated at 32 KB (120 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/argocd/refs/heads/main/openapi/argocd-applicationsetservice-api-openapi.yml