#Application

/gitops/v1/project/{project}/applications#

getList applications in a project#

Parameters#

• Authorization (in header): string

  Given Bearer token will use this as authorization for the API

• project (in path): string required

  project name

• name (in path): string required

  app name

Response#

• 200ApplicationList: success

postCreate applications in a project#

Parameters#

• Authorization (in header): string

  Given Bearer token will use this as authorization for the API

• project (in path): string required

  project name

• name (in path): string required

  app name

Response#

• 201Application: success

ApplicationList#

• apiVersion: string

  APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

• items: []Application
• kind: string

  Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

• metadata: ListMeta

  ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

Application#

• apiVersion: string

  APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

• kind: string

  Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

• metadata: ObjectMeta

  ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

• operation: Operation
• spec: ApplicationSpec
• status: ApplicationStatus

Operation#

• info: []Info
• initiatedBy: OperationInitiator
• retry: RetryStrategy
• sync: SyncOperation

Info#

• name: string
• value: string

OperationInitiator#

• automated: boolean
• username: string

RetryStrategy#

• backoff: Backoff
• limit: integer

Backoff#

• duration: string
• factor: integer
• maxDuration: string

SyncOperation#

• autoHealAttemptsCount: integer
• dryRun: boolean
• manifests: []string
• prune: boolean
• resources: []SyncOperationResource
• revision: string
• revisions: []string
• source: ApplicationSource
• sources: []ApplicationSource
• syncOptions: []string
• syncStrategy: SyncStrategy

SyncOperationResource#

• group: string
• kind: string
• name: string
• namespace: string

ApplicationSource#

• chart: string
• directory: ApplicationSourceDirectory
• helm: ApplicationSourceHelm
• kustomize: ApplicationSourceKustomize
• name: string
• path: string
• plugin: ApplicationSourcePlugin
• ref: string
• repoURL: string
• targetRevision: string

ApplicationSourceDirectory#

• exclude: string
• include: string
• jsonnet: ApplicationSourceJsonnet
• recurse: boolean

ApplicationSourceJsonnet#

• extVars: []JsonnetVar
• libs: []string
• tlas: []JsonnetVar

JsonnetVar#

• code: boolean
• name: string
• value: string

ApplicationSourceHelm#

• apiVersions: []string
• fileParameters: []HelmFileParameter
• ignoreMissingValueFiles: boolean
• kubeVersion: string
• namespace: string
• parameters: []HelmParameter
• passCredentials: boolean
• releaseName: string
• skipCrds: boolean
• skipSchemaValidation: boolean
• skipTests: boolean
• valueFiles: []string
• values: string
• valuesObject: string
• version: string

HelmFileParameter#

• name: string
• path: string

HelmParameter#

• forceString: boolean
• name: string
• value: string

ApplicationSourceKustomize#

• apiVersions: []string
• commonAnnotations: map[string]string
• commonAnnotationsEnvsubst: boolean
• commonLabels: map[string]string
• components: []string
• forceCommonAnnotations: boolean
• forceCommonLabels: boolean
• images: []string
• kubeVersion: string
• labelWithoutSelector: boolean
• namePrefix: string
• nameSuffix: string
• namespace: string
• patches: []KustomizePatch
• replicas: []KustomizeReplica
• version: string

KustomizePatch#

• options: map[string]boolean
• patch: string
• path: string
• target: KustomizeSelector

KustomizeSelector#

• annotationSelector: string
• group: string
• kind: string
• labelSelector: string
• name: string
• namespace: string
• version: string

KustomizeReplica#

• count: string
• name: string

ApplicationSourcePlugin#

• env: []EnvEntry
• name: string
• parameters: []ApplicationSourcePluginParameter

EnvEntry#

• name: string
• value: string

ApplicationSourcePluginParameter#

• OptionalArray: OptionalArray
• OptionalMap: OptionalMap
• name: string
• string: string

OptionalArray#

• array: []string

OptionalMap#

• map: map[string]string

SyncStrategy#

• apply: SyncStrategyApply
• hook: SyncStrategyHook

SyncStrategyApply#

• force: boolean

SyncStrategyHook#

• force: boolean

ApplicationSpec#

• destination: ApplicationDestination
• ignoreDifferences: []ResourceIgnoreDifferences
• info: []Info
• project: string
• revisionHistoryLimit: integer
• source: ApplicationSource
• sourceHydrator: SourceHydrator
• sources: []ApplicationSource
• syncPolicy: SyncPolicy

ApplicationDestination#

• name: string
• namespace: string
• server: string

ResourceIgnoreDifferences#

• group: string
• jqPathExpressions: []string
• jsonPointers: []string
• kind: string
• managedFieldsManagers: []string
• name: string
• namespace: string

SourceHydrator#

• drySource: DrySource
• hydrateTo: HydrateTo
• syncSource: SyncSource

DrySource#

• path: string
• repoURL: string
• targetRevision: string

HydrateTo#

• targetBranch: string

SyncSource#

• path: string
• targetBranch: string

SyncPolicy#

• automated: SyncPolicyAutomated
• managedNamespaceMetadata: ManagedNamespaceMetadata
• retry: RetryStrategy
• syncOptions: []string

SyncPolicyAutomated#

• allowEmpty: boolean
• prune: boolean
• selfHeal: boolean

ManagedNamespaceMetadata#

• annotations: map[string]string
• labels: map[string]string

ApplicationStatus#

• conditions: []ApplicationCondition
• controllerNamespace: string
• health: HealthStatus
• history: []RevisionHistory
• observedAt: string
• operationState: OperationState
• reconciledAt: string
• resourceHealthSource: string
• resources: []ResourceStatus
• sourceHydrator: SourceHydratorStatus
• sourceType: string
• sourceTypes: []string
• summary: ApplicationSummary
• sync: SyncStatus

ApplicationCondition#

• lastTransitionTime: string
• message: string
• type: string

HealthStatus#

• lastTransitionTime: string
• message: string
• status: string

RevisionHistory#

• deployStartedAt: string
• deployedAt: string
• id: integer
• initiatedBy: OperationInitiator
• revision: string
• revisions: []string
• source: ApplicationSource
• sources: []ApplicationSource

OperationState#

• finishedAt: string
• message: string
• operation: Operation
• phase: string
• retryCount: integer
• startedAt: string
• syncResult: SyncOperationResult

SyncOperationResult#

• managedNamespaceMetadata: ManagedNamespaceMetadata
• resources: []ResourceResult
• revision: string
• revisions: []string
• source: ApplicationSource
• sources: []ApplicationSource

ResourceResult#

• group: string
• hookPhase: string
• hookType: string
• kind: string
• message: string
• name: string
• namespace: string
• status: string
• syncPhase: string
• version: string

ResourceStatus#

• group: string
• health: HealthStatus
• hook: boolean
• kind: string
• name: string
• namespace: string
• requiresDeletionConfirmation: boolean
• requiresPruning: boolean
• status: string
• syncWave: integer
• version: string

SourceHydratorStatus#

• currentOperation: HydrateOperation
• lastSuccessfulOperation: SuccessfulHydrateOperation

HydrateOperation#

• drySHA: string
• finishedAt: string
• hydratedSHA: string
• message: string
• phase: string
• sourceHydrator: SourceHydrator
• startedAt: string

SuccessfulHydrateOperation#

• drySHA: string
• hydratedSHA: string
• sourceHydrator: SourceHydrator

ApplicationSummary#

• externalURLs: []string
• images: []string

SyncStatus#

• comparedTo: ComparedTo
• revision: string
• revisions: []string
• status: string

ComparedTo#

• destination: ApplicationDestination
• ignoreDifferences: []ResourceIgnoreDifferences
• source: ApplicationSource
• sources: []ApplicationSource

ListMeta#

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

• continue: string

  continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.

• remainingItemCount: integer

  remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.

• resourceVersion: string

  String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

• selfLink: string

  Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

/gitops/v1/project/{project}/applications/{name}#

getGet an application in a project#

Parameters#

• Authorization (in header): string

  Given Bearer token will use this as authorization for the API

• project (in path): string required

  project name

• name (in path): string required

  app name

Response#

• 200Application: success

putUpdate an application in a project#

Parameters#

• Authorization (in header): string

  Given Bearer token will use this as authorization for the API

• project (in path): string required

  project name

• name (in path): string required

  app name

Response#

• 200Application: success

deleteDelete an application in an project#

Parameters#

• Authorization (in header): string

  Given Bearer token will use this as authorization for the API

• project (in path): string required

  project name

• name (in path): string required

  app name

Response#

• 204: success

Application#

• apiVersion: string

  APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

• kind: string

  Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

• metadata: ObjectMeta

  ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

• operation: Operation
• spec: ApplicationSpec
• status: ApplicationStatus

Operation#

• info: []Info
• initiatedBy: OperationInitiator
• retry: RetryStrategy
• sync: SyncOperation

Info#

• name: string
• value: string

OperationInitiator#

• automated: boolean
• username: string

RetryStrategy#

• backoff: Backoff
• limit: integer

Backoff#

• duration: string
• factor: integer
• maxDuration: string

SyncOperation#

• autoHealAttemptsCount: integer
• dryRun: boolean
• manifests: []string
• prune: boolean
• resources: []SyncOperationResource
• revision: string
• revisions: []string
• source: ApplicationSource
• sources: []ApplicationSource
• syncOptions: []string
• syncStrategy: SyncStrategy

SyncOperationResource#

• group: string
• kind: string
• name: string
• namespace: string

ApplicationSource#

• chart: string
• directory: ApplicationSourceDirectory
• helm: ApplicationSourceHelm
• kustomize: ApplicationSourceKustomize
• name: string
• path: string
• plugin: ApplicationSourcePlugin
• ref: string
• repoURL: string
• targetRevision: string

ApplicationSourceDirectory#

• exclude: string
• include: string
• jsonnet: ApplicationSourceJsonnet
• recurse: boolean

ApplicationSourceJsonnet#

• extVars: []JsonnetVar
• libs: []string
• tlas: []JsonnetVar

JsonnetVar#

• code: boolean
• name: string
• value: string

ApplicationSourceHelm#

• apiVersions: []string
• fileParameters: []HelmFileParameter
• ignoreMissingValueFiles: boolean
• kubeVersion: string
• namespace: string
• parameters: []HelmParameter
• passCredentials: boolean
• releaseName: string
• skipCrds: boolean
• skipSchemaValidation: boolean
• skipTests: boolean
• valueFiles: []string
• values: string
• valuesObject: string
• version: string

HelmFileParameter#

• name: string
• path: string

HelmParameter#

• forceString: boolean
• name: string
• value: string

ApplicationSourceKustomize#

• apiVersions: []string
• commonAnnotations: map[string]string
• commonAnnotationsEnvsubst: boolean
• commonLabels: map[string]string
• components: []string
• forceCommonAnnotations: boolean
• forceCommonLabels: boolean
• images: []string
• kubeVersion: string
• labelWithoutSelector: boolean
• namePrefix: string
• nameSuffix: string
• namespace: string
• patches: []KustomizePatch
• replicas: []KustomizeReplica
• version: string

KustomizePatch#

• options: map[string]boolean
• patch: string
• path: string
• target: KustomizeSelector

KustomizeSelector#

• annotationSelector: string
• group: string
• kind: string
• labelSelector: string
• name: string
• namespace: string
• version: string

KustomizeReplica#

• count: string
• name: string

ApplicationSourcePlugin#

• env: []EnvEntry
• name: string
• parameters: []ApplicationSourcePluginParameter

EnvEntry#

• name: string
• value: string

ApplicationSourcePluginParameter#

• OptionalArray: OptionalArray
• OptionalMap: OptionalMap
• name: string
• string: string

OptionalArray#

• array: []string

OptionalMap#

• map: map[string]string

SyncStrategy#

• apply: SyncStrategyApply
• hook: SyncStrategyHook

SyncStrategyApply#

• force: boolean

SyncStrategyHook#

• force: boolean

ApplicationSpec#

• destination: ApplicationDestination
• ignoreDifferences: []ResourceIgnoreDifferences
• info: []Info
• project: string
• revisionHistoryLimit: integer
• source: ApplicationSource
• sourceHydrator: SourceHydrator
• sources: []ApplicationSource
• syncPolicy: SyncPolicy

ApplicationDestination#

• name: string
• namespace: string
• server: string

ResourceIgnoreDifferences#

• group: string
• jqPathExpressions: []string
• jsonPointers: []string
• kind: string
• managedFieldsManagers: []string
• name: string
• namespace: string

SourceHydrator#

• drySource: DrySource
• hydrateTo: HydrateTo
• syncSource: SyncSource

DrySource#

• path: string
• repoURL: string
• targetRevision: string

HydrateTo#

• targetBranch: string

SyncSource#

• path: string
• targetBranch: string

SyncPolicy#

• automated: SyncPolicyAutomated
• managedNamespaceMetadata: ManagedNamespaceMetadata
• retry: RetryStrategy
• syncOptions: []string

SyncPolicyAutomated#

• allowEmpty: boolean
• prune: boolean
• selfHeal: boolean

ManagedNamespaceMetadata#

• annotations: map[string]string
• labels: map[string]string

ApplicationStatus#

• conditions: []ApplicationCondition
• controllerNamespace: string
• health: HealthStatus
• history: []RevisionHistory
• observedAt: string
• operationState: OperationState
• reconciledAt: string
• resourceHealthSource: string
• resources: []ResourceStatus
• sourceHydrator: SourceHydratorStatus
• sourceType: string
• sourceTypes: []string
• summary: ApplicationSummary
• sync: SyncStatus

ApplicationCondition#

• lastTransitionTime: string
• message: string
• type: string

HealthStatus#

• lastTransitionTime: string
• message: string
• status: string

RevisionHistory#

• deployStartedAt: string
• deployedAt: string
• id: integer
• initiatedBy: OperationInitiator
• revision: string
• revisions: []string
• source: ApplicationSource
• sources: []ApplicationSource

OperationState#

• finishedAt: string
• message: string
• operation: Operation
• phase: string
• retryCount: integer
• startedAt: string
• syncResult: SyncOperationResult

SyncOperationResult#

• managedNamespaceMetadata: ManagedNamespaceMetadata
• resources: []ResourceResult
• revision: string
• revisions: []string
• source: ApplicationSource
• sources: []ApplicationSource

ResourceResult#

• group: string
• hookPhase: string
• hookType: string
• kind: string
• message: string
• name: string
• namespace: string
• status: string
• syncPhase: string
• version: string

ResourceStatus#

• group: string
• health: HealthStatus
• hook: boolean
• kind: string
• name: string
• namespace: string
• requiresDeletionConfirmation: boolean
• requiresPruning: boolean
• status: string
• syncWave: integer
• version: string

SourceHydratorStatus#

• currentOperation: HydrateOperation
• lastSuccessfulOperation: SuccessfulHydrateOperation

HydrateOperation#

• drySHA: string
• finishedAt: string
• hydratedSHA: string
• message: string
• phase: string
• sourceHydrator: SourceHydrator
• startedAt: string

SuccessfulHydrateOperation#

• drySHA: string
• hydratedSHA: string
• sourceHydrator: SourceHydrator

ApplicationSummary#

• externalURLs: []string
• images: []string

SyncStatus#

• comparedTo: ComparedTo
• revision: string
• revisions: []string
• status: string

ComparedTo#

• destination: ApplicationDestination
• ignoreDifferences: []ResourceIgnoreDifferences
• source: ApplicationSource
• sources: []ApplicationSource

/gitops/v1/project/{project}/applications/{name}/events#

getQuery events of an applications#

Parameters#

• Authorization (in header): string

  Given Bearer token will use this as authorization for the API

• project (in path): string required

  project name

• name (in path): string required

  app name

• start_time (in query): string

  start time

• end_time (in query): string

  end time

• reason (in query): string

  reason

• kind (in query): string

  kind

• name (in query): string

  name

• event_type (in query): string

  event type

• pageno (in query): integer

  page number

• size (in query): size

  size

Response#

• 200: success

/gitops/v1/project/{project}/applications/{name}/refresh#

postRefresh application in an project#

Parameters#

• Authorization (in header): string

  Given Bearer token will use this as authorization for the API

• project (in path): string required

  project name

• name (in path): string required

  app name

Response#

• 204: success

/gitops/v1/project/{project}/applications/{name}/sync#

postSync resources of application in an project#

Parameters#

• Authorization (in header): string

  Given Bearer token will use this as authorization for the API

• project (in path): string required

  project name

• name (in path): string required

  app name

Response#

• 204: success