Argo CD ApplicationService API
The ApplicationService API from Argo CD — 26 operation(s) for applicationservice.
The ApplicationService API from Argo CD — 26 operation(s) for applicationservice.
swagger: '2.0'
info:
description: Description of all APIs
title: Consolidate Services AccountService ApplicationService API
version: version not set
consumes:
- application/json
produces:
- application/json
tags:
- name: ApplicationService
paths:
/api/v1/applications:
get:
tags:
- ApplicationService
summary: List returns list of applications
operationId: ApplicationService_List
parameters:
- type: string
description: the application's name.
name: name
in: query
- type: string
description: forces application reconciliation if set to 'hard'.
name: refresh
in: query
- type: array
items:
type: string
collectionFormat: multi
description: the project names to restrict returned list applications.
name: projects
in: query
- type: string
description: when specified with a watch call, shows changes that occur after that particular version of a resource.
name: resourceVersion
in: query
- type: string
description: the selector to restrict returned list to applications only with matched labels.
name: selector
in: query
- type: string
description: the repoURL to restrict returned list applications.
name: repo
in: query
- type: string
description: the application's namespace.
name: appNamespace
in: query
- type: array
items:
type: string
collectionFormat: multi
description: the project names to restrict returned list applications (legacy name for backwards-compatibility).
name: project
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/v1alpha1ApplicationList'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
post:
tags:
- ApplicationService
summary: Create creates an application
operationId: ApplicationService_Create
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/v1alpha1Application'
- type: boolean
name: upsert
in: query
- type: boolean
name: validate
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/v1alpha1Application'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/manifestsWithFiles:
post:
tags:
- ApplicationService
summary: GetManifestsWithFiles returns application manifests using provided files to generate them
operationId: ApplicationService_GetManifestsWithFiles
parameters:
- description: ' (streaming inputs)'
name: body
in: body
required: true
schema:
$ref: '#/definitions/applicationApplicationManifestQueryWithFilesWrapper'
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/repositoryManifestResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{appName}/server-side-diff:
get:
tags:
- ApplicationService
summary: ServerSideDiff performs server-side diff calculation using dry-run apply
operationId: ApplicationService_ServerSideDiff
parameters:
- type: string
name: appName
in: path
required: true
- type: string
name: appNamespace
in: query
- type: string
name: project
in: query
- type: array
items:
type: string
collectionFormat: multi
name: targetManifests
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/applicationApplicationServerSideDiffResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{application.metadata.name}:
put:
tags:
- ApplicationService
summary: Update updates an application
operationId: ApplicationService_Update
parameters:
- type: string
description: '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'
name: application.metadata.name
in: path
required: true
- name: body
in: body
required: true
schema:
$ref: '#/definitions/v1alpha1Application'
- type: boolean
name: validate
in: query
- type: string
name: project
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/v1alpha1Application'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{applicationName}/managed-resources:
get:
tags:
- ApplicationService
summary: ManagedResources returns list of managed resources
operationId: ApplicationService_ManagedResources
parameters:
- type: string
name: applicationName
in: path
required: true
- type: string
name: namespace
in: query
- type: string
name: name
in: query
- type: string
name: version
in: query
- type: string
name: group
in: query
- type: string
name: kind
in: query
- type: string
name: appNamespace
in: query
- type: string
name: project
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/applicationManagedResourcesResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{applicationName}/resource-tree:
get:
tags:
- ApplicationService
summary: ResourceTree returns resource tree
operationId: ApplicationService_ResourceTree
parameters:
- type: string
name: applicationName
in: path
required: true
- type: string
name: namespace
in: query
- type: string
name: name
in: query
- type: string
name: version
in: query
- type: string
name: group
in: query
- type: string
name: kind
in: query
- type: string
name: appNamespace
in: query
- type: string
name: project
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/v1alpha1ApplicationTree'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{name}:
get:
tags:
- ApplicationService
summary: Get returns an application by name
operationId: ApplicationService_Get
parameters:
- type: string
description: the application's name
name: name
in: path
required: true
- type: string
description: forces application reconciliation if set to 'hard'.
name: refresh
in: query
- type: array
items:
type: string
collectionFormat: multi
description: the project names to restrict returned list applications.
name: projects
in: query
- type: string
description: when specified with a watch call, shows changes that occur after that particular version of a resource.
name: resourceVersion
in: query
- type: string
description: the selector to restrict returned list to applications only with matched labels.
name: selector
in: query
- type: string
description: the repoURL to restrict returned list applications.
name: repo
in: query
- type: string
description: the application's namespace.
name: appNamespace
in: query
- type: array
items:
type: string
collectionFormat: multi
description: the project names to restrict returned list applications (legacy name for backwards-compatibility).
name: project
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/v1alpha1Application'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
delete:
tags:
- ApplicationService
summary: Delete deletes an application
operationId: ApplicationService_Delete
parameters:
- type: string
name: name
in: path
required: true
- type: boolean
name: cascade
in: query
- type: string
name: propagationPolicy
in: query
- type: string
name: appNamespace
in: query
- type: string
name: project
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/applicationApplicationResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
patch:
tags:
- ApplicationService
summary: Patch patch an application
operationId: ApplicationService_Patch
parameters:
- type: string
name: name
in: path
required: true
- name: body
in: body
required: true
schema:
$ref: '#/definitions/applicationApplicationPatchRequest'
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/v1alpha1Application'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{name}/events:
get:
tags:
- ApplicationService
summary: ListResourceEvents returns a list of event resources
operationId: ApplicationService_ListResourceEvents
parameters:
- type: string
name: name
in: path
required: true
- type: string
name: resourceNamespace
in: query
- type: string
name: resourceName
in: query
- type: string
name: resourceUID
in: query
- type: string
name: appNamespace
in: query
- type: string
name: project
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/v1EventList'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{name}/links:
get:
tags:
- ApplicationService
summary: ListLinks returns the list of all application deep links
operationId: ApplicationService_ListLinks
parameters:
- type: string
name: name
in: path
required: true
- type: string
name: namespace
in: query
- type: string
name: project
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/applicationLinksResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{name}/logs:
get:
tags:
- ApplicationService
summary: PodLogs returns stream of log entries for the specified pod. Pod
operationId: ApplicationService_PodLogs2
parameters:
- type: string
name: name
in: path
required: true
- type: string
name: namespace
in: query
- type: string
name: podName
in: query
- type: string
name: container
in: query
- type: string
format: int64
name: sinceSeconds
in: query
- type: string
format: int64
description: 'Represents seconds of UTC time since Unix epoch
1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
9999-12-31T23:59:59Z inclusive.'
name: sinceTime.seconds
in: query
- type: integer
format: int32
description: 'Non-negative fractions of a second at nanosecond resolution. Negative
second values with fractions must still have non-negative nanos values
that count forward in time. Must be from 0 to 999,999,999
inclusive. This field may be limited in precision depending on context.'
name: sinceTime.nanos
in: query
- type: string
format: int64
name: tailLines
in: query
- type: boolean
name: follow
in: query
- type: string
name: untilTime
in: query
- type: string
name: filter
in: query
- type: string
name: kind
in: query
- type: string
name: group
in: query
- type: string
name: resourceName
in: query
- type: boolean
name: previous
in: query
- type: string
name: appNamespace
in: query
- type: string
name: project
in: query
- type: boolean
name: matchCase
in: query
responses:
'200':
description: A successful response.(streaming responses)
schema:
type: object
title: Stream result of applicationLogEntry
properties:
error:
$ref: '#/definitions/runtimeStreamError'
result:
$ref: '#/definitions/applicationLogEntry'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{name}/manifests:
get:
tags:
- ApplicationService
summary: GetManifests returns application manifests
operationId: ApplicationService_GetManifests
parameters:
- type: string
name: name
in: path
required: true
- type: string
name: revision
in: query
- type: string
name: appNamespace
in: query
- type: string
name: project
in: query
- type: array
items:
type: string
format: int64
collectionFormat: multi
name: sourcePositions
in: query
- type: array
items:
type: string
collectionFormat: multi
name: revisions
in: query
- type: boolean
name: noCache
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/repositoryManifestResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{name}/operation:
delete:
tags:
- ApplicationService
summary: TerminateOperation terminates the currently running operation
operationId: ApplicationService_TerminateOperation
parameters:
- type: string
name: name
in: path
required: true
- type: string
name: appNamespace
in: query
- type: string
name: project
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/applicationOperationTerminateResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{name}/pods/{podName}/logs:
get:
tags:
- ApplicationService
summary: PodLogs returns stream of log entries for the specified pod. Pod
operationId: ApplicationService_PodLogs
parameters:
- type: string
name: name
in: path
required: true
- type: string
name: podName
in: path
required: true
- type: string
name: namespace
in: query
- type: string
name: container
in: query
- type: string
format: int64
name: sinceSeconds
in: query
- type: string
format: int64
description: 'Represents seconds of UTC time since Unix epoch
1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
9999-12-31T23:59:59Z inclusive.'
name: sinceTime.seconds
in: query
- type: integer
format: int32
description: 'Non-negative fractions of a second at nanosecond resolution. Negative
second values with fractions must still have non-negative nanos values
that count forward in time. Must be from 0 to 999,999,999
inclusive. This field may be limited in precision depending on context.'
name: sinceTime.nanos
in: query
- type: string
format: int64
name: tailLines
in: query
- type: boolean
name: follow
in: query
- type: string
name: untilTime
in: query
- type: string
name: filter
in: query
- type: string
name: kind
in: query
- type: string
name: group
in: query
- type: string
name: resourceName
in: query
- type: boolean
name: previous
in: query
- type: string
name: appNamespace
in: query
- type: string
name: project
in: query
- type: boolean
name: matchCase
in: query
responses:
'200':
description: A successful response.(streaming responses)
schema:
type: object
title: Stream result of applicationLogEntry
properties:
error:
$ref: '#/definitions/runtimeStreamError'
result:
$ref: '#/definitions/applicationLogEntry'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{name}/resource:
get:
tags:
- ApplicationService
summary: GetResource returns single application resource
operationId: ApplicationService_GetResource
parameters:
- type: string
name: name
in: path
required: true
- type: string
name: namespace
in: query
- type: string
name: resourceName
in: query
- type: string
name: version
in: query
- type: string
name: group
in: query
- type: string
name: kind
in: query
- type: string
name: appNamespace
in: query
- type: string
name: project
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/applicationApplicationResourceResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
post:
tags:
- ApplicationService
summary: PatchResource patch single application resource
operationId: ApplicationService_PatchResource
parameters:
- type: string
name: name
in: path
required: true
- name: body
in: body
required: true
schema:
type: string
- type: string
name: namespace
in: query
- type: string
name: resourceName
in: query
- type: string
name: version
in: query
- type: string
name: group
in: query
- type: string
name: kind
in: query
- type: string
name: patchType
in: query
- type: string
name: appNamespace
in: query
- type: string
name: project
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/applicationApplicationResourceResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
delete:
tags:
- ApplicationService
summary: DeleteResource deletes a single application resource
operationId: ApplicationService_DeleteResource
parameters:
- type: string
name: name
in: path
required: true
- type: string
name: namespace
in: query
- type: string
name: resourceName
in: query
- type: string
name: version
in: query
- type: string
name: group
in: query
- type: string
name: kind
in: query
- type: boolean
name: force
in: query
- type: boolean
name: orphan
in: query
- type: string
name: appNamespace
in: query
- type: string
name: project
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/applicationApplicationResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{name}/resource/actions:
get:
tags:
- ApplicationService
summary: ListResourceActions returns list of resource actions
operationId: ApplicationService_ListResourceActions
parameters:
- type: string
name: name
in: path
required: true
- type: string
name: namespace
in: query
- type: string
name: resourceName
in: query
- type: string
name: version
in: query
- type: string
name: group
in: query
- type: string
name: kind
in: query
- type: string
name: appNamespace
in: query
- type: string
name: project
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/applicationResourceActionsListResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
post:
description: 'Deprecated: use RunResourceActionV2 instead. This version does not support resource action parameters but is
maintained for backward compatibility. It will be removed in a future release.'
tags:
- ApplicationService
summary: RunResourceAction runs a resource action
operationId: ApplicationService_RunResourceAction
parameters:
- type: string
name: name
in: path
required: true
- name: body
in: body
required: true
schema:
type: string
- type: string
name: namespace
in: query
- type: string
name: resourceName
in: query
- type: string
name: version
in: query
- type: string
name: group
in: query
- type: string
name: kind
in: query
- type: string
name: appNamespace
in: query
- type: string
name: project
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/applicationApplicationResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{name}/resource/actions/v2:
post:
tags:
- ApplicationService
summary: RunResourceActionV2 runs a resource action with parameters
operationId: ApplicationService_RunResourceActionV2
parameters:
- type: string
name: name
in: path
required: true
- name: body
in: body
required: true
schema:
$ref: '#/definitions/applicationResourceActionRunRequestV2'
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/applicationApplicationResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{name}/resource/links:
get:
tags:
- ApplicationService
summary: ListResourceLinks returns the list of all resource deep links
operationId: ApplicationService_ListResourceLinks
parameters:
- type: string
name: name
in: path
required: true
- type: string
name: namespace
in: query
- type: string
name: resourceName
in: query
- type: string
name: version
in: query
- type: string
name: group
in: query
- type: string
name: kind
in: query
- type: string
name: appNamespace
in: query
- type: string
name: project
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/applicationLinksResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{name}/revisions/{revision}/chartdetails:
get:
tags:
- ApplicationService
summary: Get the chart metadata (description, maintainers, home) for a specific revision of the application
operationId: ApplicationService_RevisionChartDetails
parameters:
- type: string
description: the application's name
name: name
in: path
required: true
- type: string
description: the revision of the app
name: revision
in: path
required: true
- type: string
description: the application's namespace.
name: appNamespace
in: query
- type: string
name: project
in: query
- type: integer
format: int32
description: source index (for multi source apps).
name: sourceIndex
in: query
- type: integer
format: int32
description: versionId from historical data (for multi source apps).
name: versionId
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/v1alpha1ChartDetails'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{name}/revisions/{revision}/metadata:
get:
tags:
- ApplicationService
summary: Get the meta-data (author, date, tags, message) for a specific revision of the application
operationId: ApplicationService_RevisionMetadata
parameters:
- type: string
description: the application's name
name: name
in: path
required: true
- type: string
description: the revision of the app
name: revision
in: path
required: true
- type: string
description: the application's namespace.
name: appNamespace
in: query
- type: string
name: project
in: query
- type: integer
format: int32
description: source index (for multi source apps).
name: sourceIndex
in: query
- type: integer
format: int32
description: versionId from historical data (for multi source apps).
name: versionId
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/v1alpha1RevisionMetadata'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{name}/revisions/{revision}/ocimetadata:
get:
tags:
- ApplicationService
summary: Get the chart metadata (description, maintainers, home) for a specific revision of the application
operationId: ApplicationService_GetOCIMetadata
parameters:
- type: string
description: the application's name
name: name
in: path
required: true
- type: string
description: the revision of the app
name: revision
in: path
required: true
- type: string
description: the application's namespace.
name: appNamespace
in: query
- type: string
name: project
in: query
- type: integer
format: int32
description: source index (for multi source apps).
name: sourceIndex
in: query
- type: integer
format: int32
description: versionId from historical data (for multi source apps).
name: versionId
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/v1alpha1OCIMetadata'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{name}/rollback:
post:
tags:
- ApplicationService
summary: Rollback syncs an application to its target state
operationId: ApplicationService_Rollback
parameters:
- type: string
name: name
in: path
required: true
- name: body
in: body
required: true
schema:
$ref: '#/definitions/applicationApplicationRollbackRequest'
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/v1alpha1Application'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{name}/spec:
put:
tags:
- ApplicationService
summary: UpdateSpec updates an application spec
operationId: ApplicationService_UpdateSpec
parameters:
- type: string
name: name
in: path
required: true
- name: body
in: body
required: true
schema:
$ref: '#/definitions/v1alpha1ApplicationSpec'
- type: boolean
name: validate
in: query
- type: string
name: appNamespace
in: query
- type: string
name: project
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/v1alpha1ApplicationSpec'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/applications/{name}/sync:
post
# --- truncated at 32 KB (126 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/argocd/refs/heads/main/openapi/argocd-applicationservice-api-openapi.yml