Harness

Applications

List applications for a specific agent

List returns a list of applications for a specific agent.

Securityx-api-key
Request
path Parameters
agentIdentifier
required
string

Agent identifier for entity.

query Parameters
accountIdentifier
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

query.name
string

the application's name.

query.refresh
string

forces application reconciliation if set to true.

query.project
Array of strings

the project names to restrict returned list applications.

query.resourceVersion
string

when specified with a watch call, shows changes that occur after that particular version of a resource.

query.selector
string

the selector to to restrict returned list to applications only with matched labels.

query.repo
string

the repoURL to restrict returned list applications.

Responses
200

A successful response.

default

An unexpected error response.

get/gitops/api/v1/agents/{agentIdentifier}/applications
Request samples 
Response samples 
application/json
{
  • "metadata": {
    },
  • "items": [
    ]
}
Create an application
Create creates a new application in the specified project.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
clusterIdentifier
string
 
repoIdentifier
string
 
skipRepoValidation
boolean
 
repoIdentifiers
Array of strings
 
Request Body schema: application/json
required
object (Application is a definition of Application resource.
+genclient
+genclient:noStatus
+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+kubebuilder:resource:path=applications,shortName=app;apps
+kubebuilder:printcolumn:name="Sync Status",type=string,JSONPath=`.status.sync.status`
+kubebuilder:printcolumn:name="Health Status",type=string,JSONPath=`.status.health.status`
+kubebuilder:printcolumn:name="Revision",type=string,JSONPath=`.status.sync.revision`,priority=10) 
 
upsert
boolean
 
validate
boolean
 
project
string
 
isPLG
boolean
 
Responses 
200
A successful response.


default
An unexpected error response.


post/gitops/api/v1/agents/{agentIdentifier}/applications
Request samples 
application/json
{
  • "application": {
    },
  • "upsert": true,
  • "validate": true,
  • "project": "string",
  • "isPLG": true
}
Response samples 
application/json
{
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "agentIdentifier": "string",
  • "name": "string",
  • "clusterIdentifier": "string",
  • "repoIdentifier": "string",
  • "app": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastModifiedAt": "2019-08-24T14:15:22Z",
  • "stale": true,
  • "skipRepoValidation": true,
  • "repoIdentifiers": [
    ],
  • "parentAppRef": "string"
}
Get parent application
Parent returns a parent application (app of apps or appset) by child name


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
query.name
required
string
the application's name


 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
query.refresh
string
forces application reconciliation if set to true.


 
query.project
Array of strings
the project names to restrict returned list applications.


 
query.resourceVersion
string
when specified with a watch call, shows changes that occur after that particular version of a resource.


 
query.selector
string
the selector to to restrict returned list to applications only with matched labels.


 
query.repo
string
the repoURL to restrict returned list applications.


 
Responses 
200
A successful response.


default
An unexpected error response.


get/gitops/api/v1/agents/{agentIdentifier}/applications/parent/{query.name}
Request samples 
Response samples 
application/json
{
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "agentIdentifier": "string",
  • "name": "string",
  • "clusterIdentifier": "string",
  • "repoIdentifier": "string",
  • "app": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastModifiedAt": "2019-08-24T14:15:22Z",
  • "stale": true,
  • "skipRepoValidation": true,
  • "repoIdentifiers": [
    ],
  • "parentAppRef": "string"
}
Get ManagedResources
ManagedResources returns list of managed resources.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
query.applicationName
required
string
 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
query.namespace
string
 
query.name
string
 
query.version
string
 
query.group
string
 
query.kind
string
 
Responses 
200
A successful response.


default
An unexpected error response.


get/gitops/api/v1/agents/{agentIdentifier}/applications/{query.applicationName}/managed-resources
Request samples 
Response samples 
application/json
{
  • "items": [
    ]
}
Get application
Get returns an application by name.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
query.name
required
string
the application's name


 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
query.refresh
string
forces application reconciliation if set to true.


 
query.project
Array of strings
the project names to restrict returned list applications.


 
query.resourceVersion
string
when specified with a watch call, shows changes that occur after that particular version of a resource.


 
query.selector
string
the selector to to restrict returned list to applications only with matched labels.


 
query.repo
string
the repoURL to restrict returned list applications.


 
Responses 
200
A successful response.


default
An unexpected error response.


get/gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}
Request samples 
Response samples 
application/json
{
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "agentIdentifier": "string",
  • "name": "string",
  • "clusterIdentifier": "string",
  • "repoIdentifier": "string",
  • "app": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastModifiedAt": "2019-08-24T14:15:22Z",
  • "stale": true,
  • "skipRepoValidation": true,
  • "repoIdentifiers": [
    ],
  • "parentAppRef": "string"
}
List resource events
ListResourceEvents returns a list of event resources.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
query.name
required
string
 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
query.resourceNamespace
string
 
query.resourceName
string
 
query.resourceUID
string
 
Responses 
200
A successful response.


default
An unexpected error response.


get/gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/events
Request samples 
Response samples 
application/json
{
  • "metadata": {
    },
  • "items": [
    ]
}
PodLogs returns stream of log entries for the specified pod(s).
PodLogs returns stream of log entries for the specified pod(s).


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
query.name
required
string
 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
query.namespace
string
 
query.podName
string
 
query.container
string
 
query.sinceSeconds
string <int64> 
 
query.sinceTime.seconds
string <int64> 
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.


 
query.sinceTime.nanos
integer <int32> 
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.


 
query.tailLines
string <int64> 
 
query.follow
boolean
 
query.untilTime
string
 
query.filter
string
 
query.kind
string
 
query.group
string
 
query.resourceName
string
 
query.previous
boolean
 
Responses 
200
A successful response.(streaming responses)


default
An unexpected error response.


get/gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/logs
Request samples 
Response samples 
application/json
{
  • "result": {
    },
  • "error": {
    }
}
Get application manifest
GetManifests returns an application manifests.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
query.name
required
string
 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
query.revision
string
 
Responses 
200
A successful response.


default
An unexpected error response.


get/gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/manifests
Request samples 
Response samples 
application/json
{
  • "manifests": [
    ],
  • "namespace": "string",
  • "server": "string",
  • "revision": "string",
  • "sourceType": "string",
  • "verifyResult": "string"
}
PodLogs returns stream of log entries for the specified pod(s).
PodLogs returns stream of log entries for the specified pod(s).


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
query.name
required
string
 
query.podName
required
string
 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
query.namespace
string
 
query.container
string
 
query.sinceSeconds
string <int64> 
 
query.sinceTime.seconds
string <int64> 
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.


 
query.sinceTime.nanos
integer <int32> 
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.


 
query.tailLines
string <int64> 
 
query.follow
boolean
 
query.untilTime
string
 
query.filter
string
 
query.kind
string
 
query.group
string
 
query.resourceName
string
 
query.previous
boolean
 
Responses 
200
A successful response.(streaming responses)


default
An unexpected error response.


get/gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/pods/{query.podName}/logs
Request samples 
Response samples 
application/json
{
  • "result": {
    },
  • "error": {
    }
}
Get resource tree
ResourceTree returns resource tree.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
query.name
required
string
 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
query.applicationName
string
 
query.namespace
string
 
query.version
string
 
query.group
string
 
query.kind
string
 
Responses 
200
A successful response.


default
An unexpected error response.


get/gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/resource-tree
Request samples 
Response samples 
application/json
{
  • "nodes": [
    ],
  • "orphanedNodes": [
    ],
  • "hosts": [
    ]
}
Get revision metadata
RevisionMetadata returns metadata for a specific revision of the application.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
query.name
required
string
the application's name


 
query.revision
required
string
the revision of the app


 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
Responses 
200
A successful response.


default
An unexpected error response.


get/gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/revisions/{query.revision}/metadata
Request samples 
Response samples 
application/json
{
  • "author": "string",
  • "date": {
    },
  • "tags": [
    ],
  • "message": "string",
  • "signatureInfo": "string"
}
Get sync windows of the application
GetApplicationSyncWindows returns sync windows of the application.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
query.name
required
string
 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
Responses 
200
A successful response.


default
An unexpected error response.


get/gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/syncwindows
Request samples 
Response samples 
application/json
{
  • "activeWindows": [
    ],
  • "assignedWindows": [
    ],
  • "canSync": true
}
Update an application
Update updates an application.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
request.application.metadata.name
required
string
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: http://kubernetes.io/docs/user-guide/identifiers#names
+optional


 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
clusterIdentifier
string
 
repoIdentifier
string
 
skipRepoValidation
boolean
 
repoIdentifiers
Array of strings
 
Request Body schema: application/json
required
object (Application is a definition of Application resource.
+genclient
+genclient:noStatus
+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+kubebuilder:resource:path=applications,shortName=app;apps
+kubebuilder:printcolumn:name="Sync Status",type=string,JSONPath=`.status.sync.status`
+kubebuilder:printcolumn:name="Health Status",type=string,JSONPath=`.status.health.status`
+kubebuilder:printcolumn:name="Revision",type=string,JSONPath=`.status.sync.revision`,priority=10) 
 
validate
boolean
 
Responses 
200
A successful response.


default
An unexpected error response.


put/gitops/api/v1/agents/{agentIdentifier}/applications/{request.application.metadata.name}
Request samples 
application/json
{
  • "application": {
    },
  • "validate": true
}
Response samples 
application/json
{
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "agentIdentifier": "string",
  • "name": "string",
  • "clusterIdentifier": "string",
  • "repoIdentifier": "string",
  • "app": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastModifiedAt": "2019-08-24T14:15:22Z",
  • "stale": true,
  • "skipRepoValidation": true,
  • "repoIdentifiers": [
    ],
  • "parentAppRef": "string"
}
Delete an application
Delete deletes an application.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
request.name
required
string
 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
request.cascade
boolean
 
request.propagationPolicy
string
 
options.removeExistingFinalizers
boolean
 
Responses 
200
A successful response.


default
An unexpected error response.


delete/gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}
Request samples 
Response samples 
application/json
{ }
Patch an application
Patch applies a patch to an application.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
request.name
required
string
 
Request Body schema: application/json
required
agentIdentifier
string
Agent identifier for entity.


 
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
object (ApplicationPatchRequest is a request to patch an application) 
 
Responses 
200
A successful response.


default
An unexpected error response.


patch/gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}
Request samples 
application/json
{
  • "agentIdentifier": "string",
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "request": {
    }
}
Response samples 
application/json
{
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "agentIdentifier": "string",
  • "name": "string",
  • "clusterIdentifier": "string",
  • "repoIdentifier": "string",
  • "app": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastModifiedAt": "2019-08-24T14:15:22Z",
  • "stale": true,
  • "skipRepoValidation": true,
  • "repoIdentifiers": [
    ],
  • "parentAppRef": "string"
}
Terminate operation
TerminateOperation terminates the currently running operation.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
request.name
required
string
 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
Responses 
200
A successful response.


default
An unexpected error response.


delete/gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/operation
Request samples 
Response samples 
application/json
{ }
Get an application resource
GetResource returns single application resource.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
request.name
required
string
 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
request.namespace
string
 
request.resourceName
string
 
request.version
string
 
request.group
string
 
request.kind
string
 
Responses 
200
A successful response.


default
An unexpected error response.


get/gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/resource
Request samples 
Response samples 
application/json
{
  • "manifest": "string"
}
Delete resource
DeleteResource deletes a single application resource.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
request.name
required
string
 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
request.namespace
string
 
request.resourceName
string
 
request.version
string
 
request.group
string
 
request.kind
string
 
request.force
boolean
 
request.orphan
boolean
 
Responses 
200
A successful response.


default
An unexpected error response.


delete/gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/resource
Request samples 
Response samples 
application/json
{ }
Patch an application resource
PatchResource patch single application resource.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
request.name
required
string
 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
Request Body schema: application/json
required
name
string
 
namespace
string
 
resourceName
string
 
version
string
 
group
string
 
kind
string
 
patch
string
 
patchType
string
 
Responses 
200
A successful response.


default
An unexpected error response.


post/gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/resource
Request samples 
application/json
{
  • "name": "string",
  • "namespace": "string",
  • "resourceName": "string",
  • "version": "string",
  • "group": "string",
  • "kind": "string",
  • "patch": "string",
  • "patchType": "string"
}
Response samples 
application/json
{
  • "manifest": "string"
}
List resource actions
ListResourceActions returns a list of resource actions.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
request.name
required
string
 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
request.namespace
string
 
request.resourceName
string
 
request.version
string
 
request.group
string
 
request.kind
string
 
Responses 
200
A successful response.


default
An unexpected error response.


get/gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/resource/actions
Request samples 
Response samples 
application/json
{
  • "actions": [
    ]
}
Run resource action
RunResourceAction runs a resource action.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
request.name
required
string
 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
Request Body schema: application/json
required
name
string
 
namespace
string
 
resourceName
string
 
version
string
 
group
string
 
kind
string
 
action
string
 
Responses 
200
A successful response.


default
An unexpected error response.


post/gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/resource/actions
Request samples 
application/json
{
  • "name": "string",
  • "namespace": "string",
  • "resourceName": "string",
  • "version": "string",
  • "group": "string",
  • "kind": "string",
  • "action": "string"
}
Response samples 
application/json
{ }
Rollback syncs an application to its target state
Rollback syncs an application to its target state. Harness Event type (rollback).


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
request.name
required
string
 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
Request Body schema: application/json
required
name
string
 
id
string <int64> 
 
dryRun
boolean
 
prune
boolean
 
Responses 
200
A successful response.


default
An unexpected error response.


post/gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/rollback
Request samples 
application/json
{
  • "name": "string",
  • "id": "string",
  • "dryRun": true,
  • "prune": true
}
Response samples 
application/json
{
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "agentIdentifier": "string",
  • "name": "string",
  • "clusterIdentifier": "string",
  • "repoIdentifier": "string",
  • "app": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastModifiedAt": "2019-08-24T14:15:22Z",
  • "stale": true,
  • "skipRepoValidation": true,
  • "repoIdentifiers": [
    ],
  • "parentAppRef": "string"
}
Update application spec
UpdateSpec updates an application spec.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
request.name
required
string
 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
Request Body schema: application/json
required
name
string
 
object (applicationsApplicationSpec) 
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.


 
validate
boolean
 
Responses 
200
A successful response.


default
An unexpected error response.


put/gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/spec
Request samples 
application/json
{
  • "name": "string",
  • "spec": {
    },
  • "validate": true
}
Response samples 
application/json
{
  • "source": {
    },
  • "destination": {
    },
  • "project": "string",
  • "syncPolicy": {
    },
  • "ignoreDifferences": [
    ],
  • "info": [
    ],
  • "revisionHistoryLimit": "string",
  • "sources": [
    ]
}
Sync an application
Sync syncs an application to its target state. Harness Event type (deploy)


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
request.name
required
string
 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
Request Body schema: application/json
required
name
string
 
revision
string
 
dryRun
boolean
 
prune
boolean
 
object (SyncStrategy controls the manner in which a sync is performed) 
 
Array of objects (applicationsSyncOperationResource) 
 
manifests
Array of strings
 
Array of objects (applicationsInfo) 
 
object (RetryStrategy contains information about the strategy to apply when a sync failed) 
 
object (applicationsSyncOptions) 
 
appNamespace
string
 
project
string
 
sourcePositions
Array of strings <int64> 
 
revisions
Array of strings
 
Responses 
200
A successful response.


default
An unexpected error response.


post/gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/sync
Request samples 
application/json
{
  • "name": "string",
  • "revision": "string",
  • "dryRun": true,
  • "prune": true,
  • "strategy": {
    },
  • "resources": [
    ],
  • "manifests": [
    ],
  • "infos": [
    ],
  • "retryStrategy": {
    },
  • "syncOptions": {
    },
  • "appNamespace": "string",
  • "project": "string",
  • "sourcePositions": [
    ],
  • "revisions": [
    ]
}
Response samples 
application/json
{
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "agentIdentifier": "string",
  • "name": "string",
  • "clusterIdentifier": "string",
  • "repoIdentifier": "string",
  • "app": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastModifiedAt": "2019-08-24T14:15:22Z",
  • "stale": true,
  • "skipRepoValidation": true,
  • "repoIdentifiers": [
    ],
  • "parentAppRef": "string"
}
Watch returns stream of application change events
Watch returns stream of application change events.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
query.name
string
the application's name.


 
query.refresh
string
forces application reconciliation if set to true.


 
query.project
Array of strings
the project names to restrict returned list applications.


 
query.resourceVersion
string
when specified with a watch call, shows changes that occur after that particular version of a resource.


 
query.selector
string
the selector to to restrict returned list to applications only with matched labels.


 
query.repo
string
the repoURL to restrict returned list applications.


 
Responses 
200
A successful response.(streaming responses)


default
An unexpected error response.


get/gitops/api/v1/agents/{agentIdentifier}/stream/applications
Request samples 
Response samples 
application/json
{
  • "result": {
    },
  • "error": {
    }
}
WatchResourceTree returns stream of application resource tree
WatchResourceTree returns stream of application resource tree.


Securityx-api-key 
Request 
path Parameters
agentIdentifier
required
string
Agent identifier for entity.


 
query.applicationName
required
string
 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
query.namespace
string
 
query.name
string
 
query.version
string
 
query.group
string
 
query.kind
string
 
Responses 
200
A successful response.(streaming responses)


default
An unexpected error response.


get/gitops/api/v1/agents/{agentIdentifier}/stream/applications/{query.applicationName}/resource-tree
Request samples 
Response samples 
application/json
{
  • "result": {
    },
  • "error": {
    }
}
List attributes for applications
ListAttributes returns a list of attributes for applications


Securityx-api-key 
Request 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
applicationIdentifiers
Array of strings
List of application identifiers


 
Responses 
200
A successful response.


default
An unexpected error response.


get/gitops/api/v1/applications/attributes
Request samples 
Response samples 
application/json
{
  • "content": [
    ]
}
Check if multisource feature is enabled
IsMultiSourceEnabled checks if multiple sources for an application feature is enabled


Securityx-api-key 
Request 
query Parameters
agentIdentifier
string
Agent identifier for entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
accountIdentifier
string
Account Identifier for the Entity.


 
disasterRecoveryIdentifier
string
 
Responses 
200
A successful response.


default
An unexpected error response.


get/gitops/api/v1/applications/multisource
Request samples 
Response samples 
application/json
{
  • "enabled": true
}
List namespaces for a specific query
ListNs retrieves a list of namespaces for a specific query.


Securityx-api-key 
Request 
Request Body schema: application/json
required
accountIdentifier
string
Account Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
searchTerm
string
 
pageSize
integer <int32> 
 
pageIndex
integer <int32> 
 
filter
object
Filters for Application. Eg. "app.status.sync.status": "Synced" or "app.status.sync.status": { "$in": ["Synced", "NotSynced"]


 
sortBy
string (ApplicationQueryApplicationSortByOptions) 
 Default:  "SORT_BY_NOT_SET"
 Enum: "SORT_BY_NOT_SET" "NAME" "GITOPS_AGENT" "SOURCE" "DESTINATION"  
sortOrder
string (v1SortOrderOptions) 
 Default:  "SORT_ORDER_NOT_SET"
 Enum: "SORT_ORDER_NOT_SET" "ASC" "DESC"  
metadataOnly
boolean
 
fields
Array of strings
 
Responses 
200
A successful response.


default
An unexpected error response.


post/gitops/api/v1/applications/ns
Request samples 
application/json
{
  • "accountIdentifier": "string",
  • "projectIdentifier": "string",
  • "orgIdentifier": "string",
  • "searchTerm": "string",
  • "pageSize": 0,
  • "pageIndex": 0,
  • "filter": { },
  • "sortBy": "SORT_BY_NOT_SET",
  • "sortOrder": "SORT_ORDER_NOT_SET",
  • "metadataOnly": true,
  • "fields": [
    ]
}
Response samples 
application/json
{
  • "namespaces": [
    ],
  • "totalPages": 0,
  • "totalItems": 0,
  • "pageItemCount": 0,
  • "pageSize": 0,
  • "pageIndex": 0,
  • "empty": true
}
List ApplicationSets
ListAppSets lists ApplicationSets in the specified project


Securityx-api-key 
Request 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
searchTerm
string
 
pageSize
integer <int32> 
 
pageIndex
integer <int32> 
 
Responses 
200
A successful response.


default
An unexpected error response.


get/gitops/api/v1/applications/sets
Request samples 
Response samples 
application/json
{
  • "content": [
    ],
  • "totalPages": 0,
  • "totalItems": 0,
  • "pageItemCount": 0,
  • "pageSize": 0,
  • "pageIndex": 0,
  • "empty": true
}
List application sync status
ListAppSync returns a list of application sync status


Securityx-api-key 
Request 
Request Body schema: application/json
required
accountIdentifier
string
Account Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
agentIdentifier
string
Agent identifier for entity.


 
applicationName
string
 
searchTerm
string
 
pageSize
integer <int32> 
 
pageIndex
integer <int32> 
 
endTime
integer <int32> 
 
startTime
integer <int32> 
 
operationPhase
Array of strings (v1OperationPhase) 
Items Enum: "OPERATION_PHASE_UNSET" "RUNNING" "FAILED" "SUCCEEDED"  
Responses 
200
A successful response.


default
An unexpected error response.


post/gitops/api/v1/applications/sync
Request samples 
application/json
{
  • "accountIdentifier": "string",
  • "projectIdentifier": "string",
  • "orgIdentifier": "string",
  • "agentIdentifier": "string",
  • "applicationName": "string",
  • "searchTerm": "string",
  • "pageSize": 0,
  • "pageIndex": 0,
  • "endTime": 0,
  • "startTime": 0,
  • "operationPhase": [
    ]
}
Response samples 
application/json
{
  • "content": [
    ],
  • "totalPages": 0,
  • "totalItems": 0,
  • "pageItemCount": 0,
  • "pageSize": 0,
  • "pageIndex": 0,
  • "empty": true
}
Check if an application exists
Exists checks whether an application with the given name exists.


Securityx-api-key 
Request 
path Parameters
name
required
string
 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
orgIdentifier
string
Organization Identifier for the Entity.


 
projectIdentifier
string
Project Identifier for the Entity.


 
agentIdentifier
string
Agent identifier for entity.


 
Responses 
200
A successful response.


default
An unexpected error response.


get/gitops/api/v1/applications/{name}/exists
Request samples 
Response samples 
application/json
true
➔ Next to Certificates