Applications

List returns list of applications for a specific agent

List returns list of applications for a specific agent.

Securityx-api-key

Request

path Parameters

agentIdentifier

required

string

Agent identifier for entity.

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

curl
Java
Go

Response samples

200
default

application/json

{"metadata": {"selfLink": "string",
"resourceVersion": "string",
"continue": "string",
"remainingItemCount": "string"
},
"items": [{"metadata": {"name": "string",
"generateName": "string",
"namespace": "string",
"selfLink": "string",
"uid": "string",
"resourceVersion": "string",
"generation": "string",
"creationTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionGracePeriodSeconds": "string",
"labels": {"property1": "string",
"property2": "string"
},
"annotations": {"property1": "string",
"property2": "string"
},
"ownerReferences": [{"apiVersion": "string",
"kind": "string",
"name": "string",
"uid": "string",
"controller": true,
"blockOwnerDeletion": true
}
],
"finalizers": ["string"
],
"clusterName": "string",
"managedFields": [{"manager": "string",
"operation": "string",
"apiVersion": "string",
"time": {"seconds": "string",
"nanos": 0
},
"fieldsType": "string",
"fieldsV1": {"Raw": "string"
},
"subresource": "string"
}
]
},
"spec": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": ["string"
],
"parameters": [{"name": null,
"value": null,
"forceString": null
}
],
"releaseName": "string",
"values": "string",
"fileParameters": [{"name": null,
"path": null
}
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": ["string"
],
"commonLabels": {"property1": "string",
"property2": "string"
},
"version": "string",
"commonAnnotations": {"property1": "string",
"property2": "string"
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [{"count": null,
"name": null
}
]
},
"ksonnet": {"environment": "string",
"parameters": [{"component": null,
"name": null,
"value": null
}
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [null
],
"tlas": [null
],
"libs": [null
]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [{"name": null,
"value": null
}
]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
},
"project": "string",
"syncPolicy": {"automated": {"prune": true,
"selfHeal": true,
"allowEmpty": true
},
"syncOptions": ["string"
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"ignoreDifferences": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"jsonPointers": ["string"
],
"jqPathExpressions": ["string"
],
"managedFieldsManagers": ["string"
]
}
],
"info": [{"name": "string",
"value": "string"
}
],
"revisionHistoryLimit": "string"
},
"status": {"resources": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"status": "string",
"health": {"status": "string",
"message": "string"
},
"hook": true,
"requiresPruning": true
}
],
"sync": {"status": "string",
"comparedTo": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [ ],
"parameters": [ ],
"releaseName": null,
"values": null,
"fileParameters": [ ],
"version": null,
"passCredentials": null
},
"kustomize": {"namePrefix": null,
"nameSuffix": null,
"images": [ ],
"commonLabels": { },
"version": null,
"commonAnnotations": { },
"forceCommonLabels": null,
"forceCommonAnnotations": null,
"namespace": null,
"replicas": [ ]
},
"ksonnet": {"environment": null,
"parameters": [ ]
},
"directory": {"recurse": null,
"jsonnet": null,
"exclude": null,
"include": null
},
"plugin": {"name": null,
"env": [ ]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
}
},
"revision": "string"
},
"health": {"status": "string",
"message": "string"
},
"history": [{"revision": "string",
"deployedAt": {"seconds": "string",
"nanos": 0
},
"id": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [ ],
"parameters": [ ],
"releaseName": null,
"values": null,
"fileParameters": [ ],
"version": null,
"passCredentials": null
},
"kustomize": {"namePrefix": null,
"nameSuffix": null,
"images": [ ],
"commonLabels": { },
"version": null,
"commonAnnotations": { },
"forceCommonLabels": null,
"forceCommonAnnotations": null,
"namespace": null,
"replicas": [ ]
},
"ksonnet": {"environment": null,
"parameters": [ ]
},
"directory": {"recurse": null,
"jsonnet": null,
"exclude": null,
"include": null
},
"plugin": {"name": null,
"env": [ ]
},
"chart": "string"
},
"deployStartedAt": {"seconds": "string",
"nanos": 0
},
"deployedAtTs": "2019-08-24T14:15:22Z",
"deployStartedAtTs": "2019-08-24T14:15:22Z"
}
],
"conditions": [{"type": "string",
"message": "string",
"lastTransitionTime": {"seconds": "string",
"nanos": 0
},
"lastTransitionTimeTs": "2019-08-24T14:15:22Z"
}
],
"reconciledAt": {"seconds": "string",
"nanos": 0
},
"operationState": {"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": null,
"hook": null
},
"resources": [null
],
"source": {"repoURL": null,
"path": null,
"targetRevision": null,
"helm": null,
"kustomize": null,
"ksonnet": null,
"directory": null,
"plugin": null,
"chart": null
},
"manifests": [null
],
"syncOptions": [null
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": null,
"value": null
}
],
"retry": {"limit": "string",
"backoff": {"duration": null,
"factor": null,
"maxDuration": null
}
}
},
"phase": "string",
"message": "string",
"syncResult": {"resources": [{"group": null,
"version": null,
"kind": null,
"namespace": null,
"name": null,
"status": null,
"message": null,
"hookType": null,
"hookPhase": null,
"syncPhase": null
}
],
"revision": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [ ],
"parameters": [ ],
"releaseName": null,
"values": null,
"fileParameters": [ ],
"version": null,
"passCredentials": null
},
"kustomize": {"namePrefix": null,
"nameSuffix": null,
"images": [ ],
"commonLabels": { },
"version": null,
"commonAnnotations": { },
"forceCommonLabels": null,
"forceCommonAnnotations": null,
"namespace": null,
"replicas": [ ]
},
"ksonnet": {"environment": null,
"parameters": [ ]
},
"directory": {"recurse": null,
"jsonnet": null,
"exclude": null,
"include": null
},
"plugin": {"name": null,
"env": [ ]
},
"chart": "string"
}
},
"startedAt": {"seconds": "string",
"nanos": 0
},
"finishedAt": {"seconds": "string",
"nanos": 0
},
"retryCount": "string",
"startedAtTs": "2019-08-24T14:15:22Z",
"finishedAtTs": "2019-08-24T14:15:22Z"
},
"observedAt": {"seconds": "string",
"nanos": 0
},
"sourceType": "string",
"summary": {"externalURLs": ["string"
],
"images": ["string"
]
}
},
"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": {"force": true
},
"hook": {"syncStrategyApply": {"force": null
}
}
},
"resources": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string"
}
],
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
},
"manifests": ["string"
],
"syncOptions": ["string"
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": "string",
"value": "string"
}
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
}
}
]
}

Create creates an application

Creates application in project.

Securityx-api-key

Request

path Parameters

agentIdentifier

required

string

Agent identifier for entity.

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier	string Organization Identifier for the Entity.
projectIdentifier	string Project Identifier for the Entity.
clusterIdentifier	string
repoIdentifier	string

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

Payload
curl
Java
Go

application/json

{"application": {"metadata": {"name": "string",
"generateName": "string",
"namespace": "string",
"selfLink": "string",
"uid": "string",
"resourceVersion": "string",
"generation": "string",
"creationTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionGracePeriodSeconds": "string",
"labels": {"property1": "string",
"property2": "string"
},
"annotations": {"property1": "string",
"property2": "string"
},
"ownerReferences": [{"apiVersion": "string",
"kind": "string",
"name": "string",
"uid": "string",
"controller": true,
"blockOwnerDeletion": true
}
],
"finalizers": ["string"
],
"clusterName": "string",
"managedFields": [{"manager": "string",
"operation": "string",
"apiVersion": "string",
"time": {"seconds": "string",
"nanos": 0
},
"fieldsType": "string",
"fieldsV1": {"Raw": "string"
},
"subresource": "string"
}
]
},
"spec": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": ["string"
],
"parameters": [{"name": "string",
"value": "string",
"forceString": true
}
],
"releaseName": "string",
"values": "string",
"fileParameters": [{"name": "string",
"path": "string"
}
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": ["string"
],
"commonLabels": {"property1": "string",
"property2": "string"
},
"version": "string",
"commonAnnotations": {"property1": "string",
"property2": "string"
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [{"count": "string",
"name": "string"
}
]
},
"ksonnet": {"environment": "string",
"parameters": [{"component": "string",
"name": "string",
"value": "string"
}
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [{"name": null,
"value": null,
"code": null
}
],
"tlas": [{"name": null,
"value": null,
"code": null
}
],
"libs": ["string"
]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [{"name": "string",
"value": "string"
}
]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
},
"project": "string",
"syncPolicy": {"automated": {"prune": true,
"selfHeal": true,
"allowEmpty": true
},
"syncOptions": ["string"
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"ignoreDifferences": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"jsonPointers": ["string"
],
"jqPathExpressions": ["string"
],
"managedFieldsManagers": ["string"
]
}
],
"info": [{"name": "string",
"value": "string"
}
],
"revisionHistoryLimit": "string"
},
"status": {"resources": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"status": "string",
"health": {"status": "string",
"message": "string"
},
"hook": true,
"requiresPruning": true
}
],
"sync": {"status": "string",
"comparedTo": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
}
},
"revision": "string"
},
"health": {"status": "string",
"message": "string"
},
"history": [{"revision": "string",
"deployedAt": {"seconds": "string",
"nanos": 0
},
"id": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
},
"deployStartedAt": {"seconds": "string",
"nanos": 0
},
"deployedAtTs": "2019-08-24T14:15:22Z",
"deployStartedAtTs": "2019-08-24T14:15:22Z"
}
],
"conditions": [{"type": "string",
"message": "string",
"lastTransitionTime": {"seconds": "string",
"nanos": 0
},
"lastTransitionTimeTs": "2019-08-24T14:15:22Z"
}
],
"reconciledAt": {"seconds": "string",
"nanos": 0
},
"operationState": {"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": {"force": null
},
"hook": {"syncStrategyApply": null
}
},
"resources": [{"group": null,
"kind": null,
"name": null,
"namespace": null
}
],
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [ ],
"parameters": [ ],
"releaseName": null,
"values": null,
"fileParameters": [ ],
"version": null,
"passCredentials": null
},
"kustomize": {"namePrefix": null,
"nameSuffix": null,
"images": [ ],
"commonLabels": { },
"version": null,
"commonAnnotations": { },
"forceCommonLabels": null,
"forceCommonAnnotations": null,
"namespace": null,
"replicas": [ ]
},
"ksonnet": {"environment": null,
"parameters": [ ]
},
"directory": {"recurse": null,
"jsonnet": null,
"exclude": null,
"include": null
},
"plugin": {"name": null,
"env": [ ]
},
"chart": "string"
},
"manifests": ["string"
],
"syncOptions": ["string"
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": "string",
"value": "string"
}
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"phase": "string",
"message": "string",
"syncResult": {"resources": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"status": "string",
"message": "string",
"hookType": "string",
"hookPhase": "string",
"syncPhase": "string"
}
],
"revision": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
}
},
"startedAt": {"seconds": "string",
"nanos": 0
},
"finishedAt": {"seconds": "string",
"nanos": 0
},
"retryCount": "string",
"startedAtTs": "2019-08-24T14:15:22Z",
"finishedAtTs": "2019-08-24T14:15:22Z"
},
"observedAt": {"seconds": "string",
"nanos": 0
},
"sourceType": "string",
"summary": {"externalURLs": ["string"
],
"images": ["string"
]
}
},
"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": {"force": true
},
"hook": {"syncStrategyApply": {"force": true
}
}
},
"resources": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string"
}
],
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": ["string"
],
"parameters": [{"name": null,
"value": null,
"forceString": null
}
],
"releaseName": "string",
"values": "string",
"fileParameters": [{"name": null,
"path": null
}
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": ["string"
],
"commonLabels": {"property1": "string",
"property2": "string"
},
"version": "string",
"commonAnnotations": {"property1": "string",
"property2": "string"
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [{"count": null,
"name": null
}
]
},
"ksonnet": {"environment": "string",
"parameters": [{"component": null,
"name": null,
"value": null
}
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [null
],
"tlas": [null
],
"libs": [null
]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [{"name": null,
"value": null
}
]
},
"chart": "string"
},
"manifests": ["string"
],
"syncOptions": ["string"
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": "string",
"value": "string"
}
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
}
},
"upsert": true,
"validate": true,
"project": "string",
"isPLG": true
}

Response samples

200
default

application/json

{"accountIdentifier": "string",
"orgIdentifier": "string",
"projectIdentifier": "string",
"agentIdentifier": "string",
"name": "string",
"clusterIdentifier": "string",
"repoIdentifier": "string",
"app": {"metadata": {"name": "string",
"generateName": "string",
"namespace": "string",
"selfLink": "string",
"uid": "string",
"resourceVersion": "string",
"generation": "string",
"creationTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionGracePeriodSeconds": "string",
"labels": {"property1": "string",
"property2": "string"
},
"annotations": {"property1": "string",
"property2": "string"
},
"ownerReferences": [{"apiVersion": "string",
"kind": "string",
"name": "string",
"uid": "string",
"controller": true,
"blockOwnerDeletion": true
}
],
"finalizers": ["string"
],
"clusterName": "string",
"managedFields": [{"manager": "string",
"operation": "string",
"apiVersion": "string",
"time": {"seconds": "string",
"nanos": 0
},
"fieldsType": "string",
"fieldsV1": {"Raw": "string"
},
"subresource": "string"
}
]
},
"spec": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": ["string"
],
"parameters": [{"name": "string",
"value": "string",
"forceString": true
}
],
"releaseName": "string",
"values": "string",
"fileParameters": [{"name": "string",
"path": "string"
}
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": ["string"
],
"commonLabels": {"property1": "string",
"property2": "string"
},
"version": "string",
"commonAnnotations": {"property1": "string",
"property2": "string"
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [{"count": "string",
"name": "string"
}
]
},
"ksonnet": {"environment": "string",
"parameters": [{"component": "string",
"name": "string",
"value": "string"
}
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [{"name": null,
"value": null,
"code": null
}
],
"tlas": [{"name": null,
"value": null,
"code": null
}
],
"libs": ["string"
]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [{"name": "string",
"value": "string"
}
]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
},
"project": "string",
"syncPolicy": {"automated": {"prune": true,
"selfHeal": true,
"allowEmpty": true
},
"syncOptions": ["string"
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"ignoreDifferences": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"jsonPointers": ["string"
],
"jqPathExpressions": ["string"
],
"managedFieldsManagers": ["string"
]
}
],
"info": [{"name": "string",
"value": "string"
}
],
"revisionHistoryLimit": "string"
},
"status": {"resources": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"status": "string",
"health": {"status": "string",
"message": "string"
},
"hook": true,
"requiresPruning": true
}
],
"sync": {"status": "string",
"comparedTo": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
}
},
"revision": "string"
},
"health": {"status": "string",
"message": "string"
},
"history": [{"revision": "string",
"deployedAt": {"seconds": "string",
"nanos": 0
},
"id": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
},
"deployStartedAt": {"seconds": "string",
"nanos": 0
},
"deployedAtTs": "2019-08-24T14:15:22Z",
"deployStartedAtTs": "2019-08-24T14:15:22Z"
}
],
"conditions": [{"type": "string",
"message": "string",
"lastTransitionTime": {"seconds": "string",
"nanos": 0
},
"lastTransitionTimeTs": "2019-08-24T14:15:22Z"
}
],
"reconciledAt": {"seconds": "string",
"nanos": 0
},
"operationState": {"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": {"force": null
},
"hook": {"syncStrategyApply": null
}
},
"resources": [{"group": null,
"kind": null,
"name": null,
"namespace": null
}
],
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [ ],
"parameters": [ ],
"releaseName": null,
"values": null,
"fileParameters": [ ],
"version": null,
"passCredentials": null
},
"kustomize": {"namePrefix": null,
"nameSuffix": null,
"images": [ ],
"commonLabels": { },
"version": null,
"commonAnnotations": { },
"forceCommonLabels": null,
"forceCommonAnnotations": null,
"namespace": null,
"replicas": [ ]
},
"ksonnet": {"environment": null,
"parameters": [ ]
},
"directory": {"recurse": null,
"jsonnet": null,
"exclude": null,
"include": null
},
"plugin": {"name": null,
"env": [ ]
},
"chart": "string"
},
"manifests": ["string"
],
"syncOptions": ["string"
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": "string",
"value": "string"
}
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"phase": "string",
"message": "string",
"syncResult": {"resources": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"status": "string",
"message": "string",
"hookType": "string",
"hookPhase": "string",
"syncPhase": "string"
}
],
"revision": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
}
},
"startedAt": {"seconds": "string",
"nanos": 0
},
"finishedAt": {"seconds": "string",
"nanos": 0
},
"retryCount": "string",
"startedAtTs": "2019-08-24T14:15:22Z",
"finishedAtTs": "2019-08-24T14:15:22Z"
},
"observedAt": {"seconds": "string",
"nanos": 0
},
"sourceType": "string",
"summary": {"externalURLs": ["string"
],
"images": ["string"
]
}
},
"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": {"force": true
},
"hook": {"syncStrategyApply": {"force": true
}
}
},
"resources": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string"
}
],
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": ["string"
],
"parameters": [{"name": null,
"value": null,
"forceString": null
}
],
"releaseName": "string",
"values": "string",
"fileParameters": [{"name": null,
"path": null
}
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": ["string"
],
"commonLabels": {"property1": "string",
"property2": "string"
},
"version": "string",
"commonAnnotations": {"property1": "string",
"property2": "string"
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [{"count": null,
"name": null
}
]
},
"ksonnet": {"environment": "string",
"parameters": [{"component": null,
"name": null,
"value": null
}
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [null
],
"tlas": [null
],
"libs": [null
]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [{"name": null,
"value": null
}
]
},
"chart": "string"
},
"manifests": ["string"
],
"syncOptions": ["string"
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": "string",
"value": "string"
}
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
}
},
"createdAt": "2019-08-24T14:15:22Z",
"lastModifiedAt": "2019-08-24T14:15:22Z",
"stale": true
}

ManagedResources returns list of managed resources

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 required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

curl
Java
Go

Response samples

200
default

application/json

{"items": [{"group": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"targetState": "string",
"liveState": "string",
"diff": "string",
"hook": true,
"normalizedLiveState": "string",
"predictedLiveState": "string",
"resourceVersion": "string",
"modified": true
}
]
}

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 required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

curl
Java
Go

Response samples

200
default

application/json

{"accountIdentifier": "string",
"orgIdentifier": "string",
"projectIdentifier": "string",
"agentIdentifier": "string",
"name": "string",
"clusterIdentifier": "string",
"repoIdentifier": "string",
"app": {"metadata": {"name": "string",
"generateName": "string",
"namespace": "string",
"selfLink": "string",
"uid": "string",
"resourceVersion": "string",
"generation": "string",
"creationTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionGracePeriodSeconds": "string",
"labels": {"property1": "string",
"property2": "string"
},
"annotations": {"property1": "string",
"property2": "string"
},
"ownerReferences": [{"apiVersion": "string",
"kind": "string",
"name": "string",
"uid": "string",
"controller": true,
"blockOwnerDeletion": true
}
],
"finalizers": ["string"
],
"clusterName": "string",
"managedFields": [{"manager": "string",
"operation": "string",
"apiVersion": "string",
"time": {"seconds": "string",
"nanos": 0
},
"fieldsType": "string",
"fieldsV1": {"Raw": "string"
},
"subresource": "string"
}
]
},
"spec": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": ["string"
],
"parameters": [{"name": "string",
"value": "string",
"forceString": true
}
],
"releaseName": "string",
"values": "string",
"fileParameters": [{"name": "string",
"path": "string"
}
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": ["string"
],
"commonLabels": {"property1": "string",
"property2": "string"
},
"version": "string",
"commonAnnotations": {"property1": "string",
"property2": "string"
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [{"count": "string",
"name": "string"
}
]
},
"ksonnet": {"environment": "string",
"parameters": [{"component": "string",
"name": "string",
"value": "string"
}
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [{"name": null,
"value": null,
"code": null
}
],
"tlas": [{"name": null,
"value": null,
"code": null
}
],
"libs": ["string"
]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [{"name": "string",
"value": "string"
}
]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
},
"project": "string",
"syncPolicy": {"automated": {"prune": true,
"selfHeal": true,
"allowEmpty": true
},
"syncOptions": ["string"
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"ignoreDifferences": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"jsonPointers": ["string"
],
"jqPathExpressions": ["string"
],
"managedFieldsManagers": ["string"
]
}
],
"info": [{"name": "string",
"value": "string"
}
],
"revisionHistoryLimit": "string"
},
"status": {"resources": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"status": "string",
"health": {"status": "string",
"message": "string"
},
"hook": true,
"requiresPruning": true
}
],
"sync": {"status": "string",
"comparedTo": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
}
},
"revision": "string"
},
"health": {"status": "string",
"message": "string"
},
"history": [{"revision": "string",
"deployedAt": {"seconds": "string",
"nanos": 0
},
"id": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
},
"deployStartedAt": {"seconds": "string",
"nanos": 0
},
"deployedAtTs": "2019-08-24T14:15:22Z",
"deployStartedAtTs": "2019-08-24T14:15:22Z"
}
],
"conditions": [{"type": "string",
"message": "string",
"lastTransitionTime": {"seconds": "string",
"nanos": 0
},
"lastTransitionTimeTs": "2019-08-24T14:15:22Z"
}
],
"reconciledAt": {"seconds": "string",
"nanos": 0
},
"operationState": {"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": {"force": null
},
"hook": {"syncStrategyApply": null
}
},
"resources": [{"group": null,
"kind": null,
"name": null,
"namespace": null
}
],
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [ ],
"parameters": [ ],
"releaseName": null,
"values": null,
"fileParameters": [ ],
"version": null,
"passCredentials": null
},
"kustomize": {"namePrefix": null,
"nameSuffix": null,
"images": [ ],
"commonLabels": { },
"version": null,
"commonAnnotations": { },
"forceCommonLabels": null,
"forceCommonAnnotations": null,
"namespace": null,
"replicas": [ ]
},
"ksonnet": {"environment": null,
"parameters": [ ]
},
"directory": {"recurse": null,
"jsonnet": null,
"exclude": null,
"include": null
},
"plugin": {"name": null,
"env": [ ]
},
"chart": "string"
},
"manifests": ["string"
],
"syncOptions": ["string"
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": "string",
"value": "string"
}
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"phase": "string",
"message": "string",
"syncResult": {"resources": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"status": "string",
"message": "string",
"hookType": "string",
"hookPhase": "string",
"syncPhase": "string"
}
],
"revision": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
}
},
"startedAt": {"seconds": "string",
"nanos": 0
},
"finishedAt": {"seconds": "string",
"nanos": 0
},
"retryCount": "string",
"startedAtTs": "2019-08-24T14:15:22Z",
"finishedAtTs": "2019-08-24T14:15:22Z"
},
"observedAt": {"seconds": "string",
"nanos": 0
},
"sourceType": "string",
"summary": {"externalURLs": ["string"
],
"images": ["string"
]
}
},
"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": {"force": true
},
"hook": {"syncStrategyApply": {"force": true
}
}
},
"resources": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string"
}
],
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": ["string"
],
"parameters": [{"name": null,
"value": null,
"forceString": null
}
],
"releaseName": "string",
"values": "string",
"fileParameters": [{"name": null,
"path": null
}
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": ["string"
],
"commonLabels": {"property1": "string",
"property2": "string"
},
"version": "string",
"commonAnnotations": {"property1": "string",
"property2": "string"
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [{"count": null,
"name": null
}
]
},
"ksonnet": {"environment": "string",
"parameters": [{"component": null,
"name": null,
"value": null
}
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [null
],
"tlas": [null
],
"libs": [null
]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [{"name": null,
"value": null
}
]
},
"chart": "string"
},
"manifests": ["string"
],
"syncOptions": ["string"
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": "string",
"value": "string"
}
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
}
},
"createdAt": "2019-08-24T14:15:22Z",
"lastModifiedAt": "2019-08-24T14:15:22Z",
"stale": true
}

ListResourceEvents returns a list of event resources

ListResourceEvents returns list of event resources.

Securityx-api-key

Request

path Parameters

agentIdentifier required	string Agent identifier for entity.
query.name required	string

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

curl
Java
Go

Response samples

200
default

application/json

{"metadata": {"selfLink": "string",
"resourceVersion": "string",
"continue": "string",
"remainingItemCount": "string"
},
"items": [{"metadata": {"name": "string",
"generateName": "string",
"namespace": "string",
"selfLink": "string",
"uid": "string",
"resourceVersion": "string",
"generation": "string",
"creationTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionGracePeriodSeconds": "string",
"labels": {"property1": "string",
"property2": "string"
},
"annotations": {"property1": "string",
"property2": "string"
},
"ownerReferences": [{"apiVersion": "string",
"kind": "string",
"name": "string",
"uid": "string",
"controller": true,
"blockOwnerDeletion": true
}
],
"finalizers": ["string"
],
"clusterName": "string",
"managedFields": [{"manager": "string",
"operation": "string",
"apiVersion": "string",
"time": {"seconds": "string",
"nanos": 0
},
"fieldsType": "string",
"fieldsV1": {"Raw": "string"
},
"subresource": "string"
}
]
},
"involvedObject": {"kind": "string",
"namespace": "string",
"name": "string",
"uid": "string",
"apiVersion": "string",
"resourceVersion": "string",
"fieldPath": "string"
},
"reason": "string",
"message": "string",
"source": {"component": "string",
"host": "string"
},
"firstTimestamp": {"seconds": "string",
"nanos": 0
},
"lastTimestamp": {"seconds": "string",
"nanos": 0
},
"count": 0,
"type": "string",
"eventTime": {"seconds": "string",
"nanos": 0
},
"series": {"count": 0,
"lastObservedTime": {"seconds": "string",
"nanos": 0
}
},
"action": "string",
"related": {"kind": "string",
"namespace": "string",
"name": "string",
"uid": "string",
"apiVersion": "string",
"resourceVersion": "string",
"fieldPath": "string"
},
"reportingComponent": "string",
"reportingInstance": "string",
"firstTimestampTs": "2019-08-24T14:15:22Z",
"lastTimestampTs": "2019-08-24T14:15:22Z"
}
]
}

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 required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

curl
Java
Go

Response samples

200
default

application/json

{"result": {"content": "string",
"timeStamp": {"seconds": "string",
"nanos": 0
},
"last": true,
"timeStampStr": "string",
"podName": "string"
},
"error": {"grpc_code": 0,
"http_code": 0,
"message": "string",
"http_status": "string",
"details": [{"type_url": "string",
"value": "string"
}
]
}
}

GetManifests returns application manifests

GetManifests returns application manifests.

Securityx-api-key

Request

path Parameters

agentIdentifier required	string Agent identifier for entity.
query.name required	string

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

curl
Java
Go

Response samples

200
default

application/json

{"manifests": ["string"
],
"namespace": "string",
"server": "string",
"revision": "string",
"sourceType": "string",
"verifyResult": "string"
}

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 required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

curl
Java
Go

Response samples

200
default

application/json

{"result": {"content": "string",
"timeStamp": {"seconds": "string",
"nanos": 0
},
"last": true,
"timeStampStr": "string",
"podName": "string"
},
"error": {"grpc_code": 0,
"http_code": 0,
"message": "string",
"http_status": "string",
"details": [{"type_url": "string",
"value": "string"
}
]
}
}

ResourceTree returns 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 required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

curl
Java
Go

Response samples

200
default

application/json

{"nodes": [{"resourceRef": {"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"uid": "string"
},
"parentRefs": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"uid": "string"
}
],
"info": [{"name": "string",
"value": "string"
}
],
"networkingInfo": {"targetLabels": {"property1": "string",
"property2": "string"
},
"targetRefs": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"uid": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"ingress": [{"ip": "string",
"hostname": "string",
"ports": [{"port": null,
"protocol": null,
"error": null
}
]
}
],
"externalURLs": ["string"
]
},
"resourceVersion": "string",
"images": ["string"
],
"health": {"status": "string",
"message": "string"
},
"createdAt": {"seconds": "string",
"nanos": 0
}
}
],
"orphanedNodes": [{"resourceRef": {"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"uid": "string"
},
"parentRefs": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"uid": "string"
}
],
"info": [{"name": "string",
"value": "string"
}
],
"networkingInfo": {"targetLabels": {"property1": "string",
"property2": "string"
},
"targetRefs": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"uid": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"ingress": [{"ip": "string",
"hostname": "string",
"ports": [{"port": null,
"protocol": null,
"error": null
}
]
}
],
"externalURLs": ["string"
]
},
"resourceVersion": "string",
"images": ["string"
],
"health": {"status": "string",
"message": "string"
},
"createdAt": {"seconds": "string",
"nanos": 0
}
}
],
"hosts": [{"name": "string",
"resourcesInfo": [{"resourceName": "string",
"requestedByApp": "string",
"requestedByNeighbors": "string",
"capacity": "string"
}
],
"systemInfo": {"machineID": "string",
"systemUUID": "string",
"bootID": "string",
"kernelVersion": "string",
"osImage": "string",
"containerRuntimeVersion": "string",
"kubeletVersion": "string",
"kubeProxyVersion": "string",
"operatingSystem": "string",
"architecture": "string"
}
}
]
}

Get the meta-data (author, date, tags, message) for a specific revision of the application

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 required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

curl
Java
Go

Response samples

200
default

application/json

{"author": "string",
"date": {"seconds": "string",
"nanos": 0
},
"tags": ["string"
],
"message": "string",
"signatureInfo": "string"
}

Get returns 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 required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

curl
Java
Go

Response samples

200
default

application/json

{"activeWindows": [{"kind": "string",
"schedule": "string",
"duration": "string",
"manualSync": true
}
],
"assignedWindows": [{"kind": "string",
"schedule": "string",
"duration": "string",
"manualSync": true
}
],
"canSync": true
}

Update updates 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 required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	string Project Identifier for the Entity.
clusterIdentifier	string
repoIdentifier	string

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

Payload
curl
Java
Go

application/json

{"application": {"metadata": {"name": "string",
"generateName": "string",
"namespace": "string",
"selfLink": "string",
"uid": "string",
"resourceVersion": "string",
"generation": "string",
"creationTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionGracePeriodSeconds": "string",
"labels": {"property1": "string",
"property2": "string"
},
"annotations": {"property1": "string",
"property2": "string"
},
"ownerReferences": [{"apiVersion": "string",
"kind": "string",
"name": "string",
"uid": "string",
"controller": true,
"blockOwnerDeletion": true
}
],
"finalizers": ["string"
],
"clusterName": "string",
"managedFields": [{"manager": "string",
"operation": "string",
"apiVersion": "string",
"time": {"seconds": "string",
"nanos": 0
},
"fieldsType": "string",
"fieldsV1": {"Raw": "string"
},
"subresource": "string"
}
]
},
"spec": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": ["string"
],
"parameters": [{"name": "string",
"value": "string",
"forceString": true
}
],
"releaseName": "string",
"values": "string",
"fileParameters": [{"name": "string",
"path": "string"
}
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": ["string"
],
"commonLabels": {"property1": "string",
"property2": "string"
},
"version": "string",
"commonAnnotations": {"property1": "string",
"property2": "string"
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [{"count": "string",
"name": "string"
}
]
},
"ksonnet": {"environment": "string",
"parameters": [{"component": "string",
"name": "string",
"value": "string"
}
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [{"name": null,
"value": null,
"code": null
}
],
"tlas": [{"name": null,
"value": null,
"code": null
}
],
"libs": ["string"
]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [{"name": "string",
"value": "string"
}
]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
},
"project": "string",
"syncPolicy": {"automated": {"prune": true,
"selfHeal": true,
"allowEmpty": true
},
"syncOptions": ["string"
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"ignoreDifferences": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"jsonPointers": ["string"
],
"jqPathExpressions": ["string"
],
"managedFieldsManagers": ["string"
]
}
],
"info": [{"name": "string",
"value": "string"
}
],
"revisionHistoryLimit": "string"
},
"status": {"resources": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"status": "string",
"health": {"status": "string",
"message": "string"
},
"hook": true,
"requiresPruning": true
}
],
"sync": {"status": "string",
"comparedTo": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
}
},
"revision": "string"
},
"health": {"status": "string",
"message": "string"
},
"history": [{"revision": "string",
"deployedAt": {"seconds": "string",
"nanos": 0
},
"id": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
},
"deployStartedAt": {"seconds": "string",
"nanos": 0
},
"deployedAtTs": "2019-08-24T14:15:22Z",
"deployStartedAtTs": "2019-08-24T14:15:22Z"
}
],
"conditions": [{"type": "string",
"message": "string",
"lastTransitionTime": {"seconds": "string",
"nanos": 0
},
"lastTransitionTimeTs": "2019-08-24T14:15:22Z"
}
],
"reconciledAt": {"seconds": "string",
"nanos": 0
},
"operationState": {"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": {"force": null
},
"hook": {"syncStrategyApply": null
}
},
"resources": [{"group": null,
"kind": null,
"name": null,
"namespace": null
}
],
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [ ],
"parameters": [ ],
"releaseName": null,
"values": null,
"fileParameters": [ ],
"version": null,
"passCredentials": null
},
"kustomize": {"namePrefix": null,
"nameSuffix": null,
"images": [ ],
"commonLabels": { },
"version": null,
"commonAnnotations": { },
"forceCommonLabels": null,
"forceCommonAnnotations": null,
"namespace": null,
"replicas": [ ]
},
"ksonnet": {"environment": null,
"parameters": [ ]
},
"directory": {"recurse": null,
"jsonnet": null,
"exclude": null,
"include": null
},
"plugin": {"name": null,
"env": [ ]
},
"chart": "string"
},
"manifests": ["string"
],
"syncOptions": ["string"
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": "string",
"value": "string"
}
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"phase": "string",
"message": "string",
"syncResult": {"resources": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"status": "string",
"message": "string",
"hookType": "string",
"hookPhase": "string",
"syncPhase": "string"
}
],
"revision": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
}
},
"startedAt": {"seconds": "string",
"nanos": 0
},
"finishedAt": {"seconds": "string",
"nanos": 0
},
"retryCount": "string",
"startedAtTs": "2019-08-24T14:15:22Z",
"finishedAtTs": "2019-08-24T14:15:22Z"
},
"observedAt": {"seconds": "string",
"nanos": 0
},
"sourceType": "string",
"summary": {"externalURLs": ["string"
],
"images": ["string"
]
}
},
"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": {"force": true
},
"hook": {"syncStrategyApply": {"force": true
}
}
},
"resources": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string"
}
],
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": ["string"
],
"parameters": [{"name": null,
"value": null,
"forceString": null
}
],
"releaseName": "string",
"values": "string",
"fileParameters": [{"name": null,
"path": null
}
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": ["string"
],
"commonLabels": {"property1": "string",
"property2": "string"
},
"version": "string",
"commonAnnotations": {"property1": "string",
"property2": "string"
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [{"count": null,
"name": null
}
]
},
"ksonnet": {"environment": "string",
"parameters": [{"component": null,
"name": null,
"value": null
}
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [null
],
"tlas": [null
],
"libs": [null
]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [{"name": null,
"value": null
}
]
},
"chart": "string"
},
"manifests": ["string"
],
"syncOptions": ["string"
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": "string",
"value": "string"
}
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
}
},
"validate": true
}

Response samples

200
default

application/json

{"accountIdentifier": "string",
"orgIdentifier": "string",
"projectIdentifier": "string",
"agentIdentifier": "string",
"name": "string",
"clusterIdentifier": "string",
"repoIdentifier": "string",
"app": {"metadata": {"name": "string",
"generateName": "string",
"namespace": "string",
"selfLink": "string",
"uid": "string",
"resourceVersion": "string",
"generation": "string",
"creationTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionGracePeriodSeconds": "string",
"labels": {"property1": "string",
"property2": "string"
},
"annotations": {"property1": "string",
"property2": "string"
},
"ownerReferences": [{"apiVersion": "string",
"kind": "string",
"name": "string",
"uid": "string",
"controller": true,
"blockOwnerDeletion": true
}
],
"finalizers": ["string"
],
"clusterName": "string",
"managedFields": [{"manager": "string",
"operation": "string",
"apiVersion": "string",
"time": {"seconds": "string",
"nanos": 0
},
"fieldsType": "string",
"fieldsV1": {"Raw": "string"
},
"subresource": "string"
}
]
},
"spec": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": ["string"
],
"parameters": [{"name": "string",
"value": "string",
"forceString": true
}
],
"releaseName": "string",
"values": "string",
"fileParameters": [{"name": "string",
"path": "string"
}
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": ["string"
],
"commonLabels": {"property1": "string",
"property2": "string"
},
"version": "string",
"commonAnnotations": {"property1": "string",
"property2": "string"
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [{"count": "string",
"name": "string"
}
]
},
"ksonnet": {"environment": "string",
"parameters": [{"component": "string",
"name": "string",
"value": "string"
}
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [{"name": null,
"value": null,
"code": null
}
],
"tlas": [{"name": null,
"value": null,
"code": null
}
],
"libs": ["string"
]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [{"name": "string",
"value": "string"
}
]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
},
"project": "string",
"syncPolicy": {"automated": {"prune": true,
"selfHeal": true,
"allowEmpty": true
},
"syncOptions": ["string"
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"ignoreDifferences": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"jsonPointers": ["string"
],
"jqPathExpressions": ["string"
],
"managedFieldsManagers": ["string"
]
}
],
"info": [{"name": "string",
"value": "string"
}
],
"revisionHistoryLimit": "string"
},
"status": {"resources": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"status": "string",
"health": {"status": "string",
"message": "string"
},
"hook": true,
"requiresPruning": true
}
],
"sync": {"status": "string",
"comparedTo": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
}
},
"revision": "string"
},
"health": {"status": "string",
"message": "string"
},
"history": [{"revision": "string",
"deployedAt": {"seconds": "string",
"nanos": 0
},
"id": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
},
"deployStartedAt": {"seconds": "string",
"nanos": 0
},
"deployedAtTs": "2019-08-24T14:15:22Z",
"deployStartedAtTs": "2019-08-24T14:15:22Z"
}
],
"conditions": [{"type": "string",
"message": "string",
"lastTransitionTime": {"seconds": "string",
"nanos": 0
},
"lastTransitionTimeTs": "2019-08-24T14:15:22Z"
}
],
"reconciledAt": {"seconds": "string",
"nanos": 0
},
"operationState": {"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": {"force": null
},
"hook": {"syncStrategyApply": null
}
},
"resources": [{"group": null,
"kind": null,
"name": null,
"namespace": null
}
],
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [ ],
"parameters": [ ],
"releaseName": null,
"values": null,
"fileParameters": [ ],
"version": null,
"passCredentials": null
},
"kustomize": {"namePrefix": null,
"nameSuffix": null,
"images": [ ],
"commonLabels": { },
"version": null,
"commonAnnotations": { },
"forceCommonLabels": null,
"forceCommonAnnotations": null,
"namespace": null,
"replicas": [ ]
},
"ksonnet": {"environment": null,
"parameters": [ ]
},
"directory": {"recurse": null,
"jsonnet": null,
"exclude": null,
"include": null
},
"plugin": {"name": null,
"env": [ ]
},
"chart": "string"
},
"manifests": ["string"
],
"syncOptions": ["string"
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": "string",
"value": "string"
}
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"phase": "string",
"message": "string",
"syncResult": {"resources": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"status": "string",
"message": "string",
"hookType": "string",
"hookPhase": "string",
"syncPhase": "string"
}
],
"revision": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
}
},
"startedAt": {"seconds": "string",
"nanos": 0
},
"finishedAt": {"seconds": "string",
"nanos": 0
},
"retryCount": "string",
"startedAtTs": "2019-08-24T14:15:22Z",
"finishedAtTs": "2019-08-24T14:15:22Z"
},
"observedAt": {"seconds": "string",
"nanos": 0
},
"sourceType": "string",
"summary": {"externalURLs": ["string"
],
"images": ["string"
]
}
},
"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": {"force": true
},
"hook": {"syncStrategyApply": {"force": true
}
}
},
"resources": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string"
}
],
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": ["string"
],
"parameters": [{"name": null,
"value": null,
"forceString": null
}
],
"releaseName": "string",
"values": "string",
"fileParameters": [{"name": null,
"path": null
}
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": ["string"
],
"commonLabels": {"property1": "string",
"property2": "string"
},
"version": "string",
"commonAnnotations": {"property1": "string",
"property2": "string"
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [{"count": null,
"name": null
}
]
},
"ksonnet": {"environment": "string",
"parameters": [{"component": null,
"name": null,
"value": null
}
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [null
],
"tlas": [null
],
"libs": [null
]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [{"name": null,
"value": null
}
]
},
"chart": "string"
},
"manifests": ["string"
],
"syncOptions": ["string"
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": "string",
"value": "string"
}
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
}
},
"createdAt": "2019-08-24T14:15:22Z",
"lastModifiedAt": "2019-08-24T14:15:22Z",
"stale": true
}

Delete deletes 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 required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

curl
Java
Go

Response samples

200
default

application/json

{ }

Patch patch an application

Patch applys a patches 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

Payload
curl
Java
Go

application/json

{"agentIdentifier": "string",
"accountIdentifier": "string",
"orgIdentifier": "string",
"projectIdentifier": "string",
"request": {"name": "string",
"patch": "string",
"patchType": "string"
}
}

Response samples

200
default

application/json

{"accountIdentifier": "string",
"orgIdentifier": "string",
"projectIdentifier": "string",
"agentIdentifier": "string",
"name": "string",
"clusterIdentifier": "string",
"repoIdentifier": "string",
"app": {"metadata": {"name": "string",
"generateName": "string",
"namespace": "string",
"selfLink": "string",
"uid": "string",
"resourceVersion": "string",
"generation": "string",
"creationTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionGracePeriodSeconds": "string",
"labels": {"property1": "string",
"property2": "string"
},
"annotations": {"property1": "string",
"property2": "string"
},
"ownerReferences": [{"apiVersion": "string",
"kind": "string",
"name": "string",
"uid": "string",
"controller": true,
"blockOwnerDeletion": true
}
],
"finalizers": ["string"
],
"clusterName": "string",
"managedFields": [{"manager": "string",
"operation": "string",
"apiVersion": "string",
"time": {"seconds": "string",
"nanos": 0
},
"fieldsType": "string",
"fieldsV1": {"Raw": "string"
},
"subresource": "string"
}
]
},
"spec": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": ["string"
],
"parameters": [{"name": "string",
"value": "string",
"forceString": true
}
],
"releaseName": "string",
"values": "string",
"fileParameters": [{"name": "string",
"path": "string"
}
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": ["string"
],
"commonLabels": {"property1": "string",
"property2": "string"
},
"version": "string",
"commonAnnotations": {"property1": "string",
"property2": "string"
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [{"count": "string",
"name": "string"
}
]
},
"ksonnet": {"environment": "string",
"parameters": [{"component": "string",
"name": "string",
"value": "string"
}
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [{"name": null,
"value": null,
"code": null
}
],
"tlas": [{"name": null,
"value": null,
"code": null
}
],
"libs": ["string"
]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [{"name": "string",
"value": "string"
}
]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
},
"project": "string",
"syncPolicy": {"automated": {"prune": true,
"selfHeal": true,
"allowEmpty": true
},
"syncOptions": ["string"
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"ignoreDifferences": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"jsonPointers": ["string"
],
"jqPathExpressions": ["string"
],
"managedFieldsManagers": ["string"
]
}
],
"info": [{"name": "string",
"value": "string"
}
],
"revisionHistoryLimit": "string"
},
"status": {"resources": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"status": "string",
"health": {"status": "string",
"message": "string"
},
"hook": true,
"requiresPruning": true
}
],
"sync": {"status": "string",
"comparedTo": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
}
},
"revision": "string"
},
"health": {"status": "string",
"message": "string"
},
"history": [{"revision": "string",
"deployedAt": {"seconds": "string",
"nanos": 0
},
"id": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
},
"deployStartedAt": {"seconds": "string",
"nanos": 0
},
"deployedAtTs": "2019-08-24T14:15:22Z",
"deployStartedAtTs": "2019-08-24T14:15:22Z"
}
],
"conditions": [{"type": "string",
"message": "string",
"lastTransitionTime": {"seconds": "string",
"nanos": 0
},
"lastTransitionTimeTs": "2019-08-24T14:15:22Z"
}
],
"reconciledAt": {"seconds": "string",
"nanos": 0
},
"operationState": {"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": {"force": null
},
"hook": {"syncStrategyApply": null
}
},
"resources": [{"group": null,
"kind": null,
"name": null,
"namespace": null
}
],
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [ ],
"parameters": [ ],
"releaseName": null,
"values": null,
"fileParameters": [ ],
"version": null,
"passCredentials": null
},
"kustomize": {"namePrefix": null,
"nameSuffix": null,
"images": [ ],
"commonLabels": { },
"version": null,
"commonAnnotations": { },
"forceCommonLabels": null,
"forceCommonAnnotations": null,
"namespace": null,
"replicas": [ ]
},
"ksonnet": {"environment": null,
"parameters": [ ]
},
"directory": {"recurse": null,
"jsonnet": null,
"exclude": null,
"include": null
},
"plugin": {"name": null,
"env": [ ]
},
"chart": "string"
},
"manifests": ["string"
],
"syncOptions": ["string"
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": "string",
"value": "string"
}
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"phase": "string",
"message": "string",
"syncResult": {"resources": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"status": "string",
"message": "string",
"hookType": "string",
"hookPhase": "string",
"syncPhase": "string"
}
],
"revision": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
}
},
"startedAt": {"seconds": "string",
"nanos": 0
},
"finishedAt": {"seconds": "string",
"nanos": 0
},
"retryCount": "string",
"startedAtTs": "2019-08-24T14:15:22Z",
"finishedAtTs": "2019-08-24T14:15:22Z"
},
"observedAt": {"seconds": "string",
"nanos": 0
},
"sourceType": "string",
"summary": {"externalURLs": ["string"
],
"images": ["string"
]
}
},
"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": {"force": true
},
"hook": {"syncStrategyApply": {"force": true
}
}
},
"resources": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string"
}
],
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": ["string"
],
"parameters": [{"name": null,
"value": null,
"forceString": null
}
],
"releaseName": "string",
"values": "string",
"fileParameters": [{"name": null,
"path": null
}
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": ["string"
],
"commonLabels": {"property1": "string",
"property2": "string"
},
"version": "string",
"commonAnnotations": {"property1": "string",
"property2": "string"
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [{"count": null,
"name": null
}
]
},
"ksonnet": {"environment": "string",
"parameters": [{"component": null,
"name": null,
"value": null
}
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [null
],
"tlas": [null
],
"libs": [null
]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [{"name": null,
"value": null
}
]
},
"chart": "string"
},
"manifests": ["string"
],
"syncOptions": ["string"
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": "string",
"value": "string"
}
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
}
},
"createdAt": "2019-08-24T14:15:22Z",
"lastModifiedAt": "2019-08-24T14:15:22Z",
"stale": true
}

TerminateOperation terminates the currently running 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 required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

curl
Java
Go

Response samples

200
default

application/json

{ }

GetResource returns single 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 required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

curl
Java
Go

Response samples

200
default

application/json

{"manifest": "string"
}

DeleteResource deletes a single application 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 required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

curl
Java
Go

Response samples

200
default

application/json

{ }

PatchResource patch single 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 required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

Payload
curl
Java
Go

application/json

{"name": "string",
"namespace": "string",
"resourceName": "string",
"version": "string",
"group": "string",
"kind": "string",
"patch": "string",
"patchType": "string"
}

Response samples

200
default

application/json

{"manifest": "string"
}

ListResourceActions returns list of resource actions

ListResourceActions returns list of resource actions.

Securityx-api-key

Request

path Parameters

agentIdentifier required	string Agent identifier for entity.
request.name required	string

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

curl
Java
Go

Response samples

200
default

application/json

{"actions": [{"name": "string",
"params": [{"name": "string",
"value": "string",
"type": "string",
"default": "string"
}
],
"disabled": true
}
]
}

RunResourceAction run resource action

RunResourceAction run resource action.

Securityx-api-key

Request

path Parameters

agentIdentifier required	string Agent identifier for entity.
request.name required	string

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

Payload
curl
Java
Go

application/json

{"name": "string",
"namespace": "string",
"resourceName": "string",
"version": "string",
"group": "string",
"kind": "string",
"action": "string"
}

Response samples

200
default

application/json

{ }

Rollback syncs an application to its target state Harness Event type (rollback)

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 required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

Payload
curl
Java
Go

application/json

{"name": "string",
"id": "string",
"dryRun": true,
"prune": true
}

Response samples

200
default

application/json

{"accountIdentifier": "string",
"orgIdentifier": "string",
"projectIdentifier": "string",
"agentIdentifier": "string",
"name": "string",
"clusterIdentifier": "string",
"repoIdentifier": "string",
"app": {"metadata": {"name": "string",
"generateName": "string",
"namespace": "string",
"selfLink": "string",
"uid": "string",
"resourceVersion": "string",
"generation": "string",
"creationTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionGracePeriodSeconds": "string",
"labels": {"property1": "string",
"property2": "string"
},
"annotations": {"property1": "string",
"property2": "string"
},
"ownerReferences": [{"apiVersion": "string",
"kind": "string",
"name": "string",
"uid": "string",
"controller": true,
"blockOwnerDeletion": true
}
],
"finalizers": ["string"
],
"clusterName": "string",
"managedFields": [{"manager": "string",
"operation": "string",
"apiVersion": "string",
"time": {"seconds": "string",
"nanos": 0
},
"fieldsType": "string",
"fieldsV1": {"Raw": "string"
},
"subresource": "string"
}
]
},
"spec": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": ["string"
],
"parameters": [{"name": "string",
"value": "string",
"forceString": true
}
],
"releaseName": "string",
"values": "string",
"fileParameters": [{"name": "string",
"path": "string"
}
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": ["string"
],
"commonLabels": {"property1": "string",
"property2": "string"
},
"version": "string",
"commonAnnotations": {"property1": "string",
"property2": "string"
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [{"count": "string",
"name": "string"
}
]
},
"ksonnet": {"environment": "string",
"parameters": [{"component": "string",
"name": "string",
"value": "string"
}
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [{"name": null,
"value": null,
"code": null
}
],
"tlas": [{"name": null,
"value": null,
"code": null
}
],
"libs": ["string"
]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [{"name": "string",
"value": "string"
}
]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
},
"project": "string",
"syncPolicy": {"automated": {"prune": true,
"selfHeal": true,
"allowEmpty": true
},
"syncOptions": ["string"
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"ignoreDifferences": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"jsonPointers": ["string"
],
"jqPathExpressions": ["string"
],
"managedFieldsManagers": ["string"
]
}
],
"info": [{"name": "string",
"value": "string"
}
],
"revisionHistoryLimit": "string"
},
"status": {"resources": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"status": "string",
"health": {"status": "string",
"message": "string"
},
"hook": true,
"requiresPruning": true
}
],
"sync": {"status": "string",
"comparedTo": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
}
},
"revision": "string"
},
"health": {"status": "string",
"message": "string"
},
"history": [{"revision": "string",
"deployedAt": {"seconds": "string",
"nanos": 0
},
"id": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
},
"deployStartedAt": {"seconds": "string",
"nanos": 0
},
"deployedAtTs": "2019-08-24T14:15:22Z",
"deployStartedAtTs": "2019-08-24T14:15:22Z"
}
],
"conditions": [{"type": "string",
"message": "string",
"lastTransitionTime": {"seconds": "string",
"nanos": 0
},
"lastTransitionTimeTs": "2019-08-24T14:15:22Z"
}
],
"reconciledAt": {"seconds": "string",
"nanos": 0
},
"operationState": {"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": {"force": null
},
"hook": {"syncStrategyApply": null
}
},
"resources": [{"group": null,
"kind": null,
"name": null,
"namespace": null
}
],
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [ ],
"parameters": [ ],
"releaseName": null,
"values": null,
"fileParameters": [ ],
"version": null,
"passCredentials": null
},
"kustomize": {"namePrefix": null,
"nameSuffix": null,
"images": [ ],
"commonLabels": { },
"version": null,
"commonAnnotations": { },
"forceCommonLabels": null,
"forceCommonAnnotations": null,
"namespace": null,
"replicas": [ ]
},
"ksonnet": {"environment": null,
"parameters": [ ]
},
"directory": {"recurse": null,
"jsonnet": null,
"exclude": null,
"include": null
},
"plugin": {"name": null,
"env": [ ]
},
"chart": "string"
},
"manifests": ["string"
],
"syncOptions": ["string"
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": "string",
"value": "string"
}
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"phase": "string",
"message": "string",
"syncResult": {"resources": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"status": "string",
"message": "string",
"hookType": "string",
"hookPhase": "string",
"syncPhase": "string"
}
],
"revision": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
}
},
"startedAt": {"seconds": "string",
"nanos": 0
},
"finishedAt": {"seconds": "string",
"nanos": 0
},
"retryCount": "string",
"startedAtTs": "2019-08-24T14:15:22Z",
"finishedAtTs": "2019-08-24T14:15:22Z"
},
"observedAt": {"seconds": "string",
"nanos": 0
},
"sourceType": "string",
"summary": {"externalURLs": ["string"
],
"images": ["string"
]
}
},
"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": {"force": true
},
"hook": {"syncStrategyApply": {"force": true
}
}
},
"resources": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string"
}
],
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": ["string"
],
"parameters": [{"name": null,
"value": null,
"forceString": null
}
],
"releaseName": "string",
"values": "string",
"fileParameters": [{"name": null,
"path": null
}
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": ["string"
],
"commonLabels": {"property1": "string",
"property2": "string"
},
"version": "string",
"commonAnnotations": {"property1": "string",
"property2": "string"
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [{"count": null,
"name": null
}
]
},
"ksonnet": {"environment": "string",
"parameters": [{"component": null,
"name": null,
"value": null
}
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [null
],
"tlas": [null
],
"libs": [null
]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [{"name": null,
"value": null
}
]
},
"chart": "string"
},
"manifests": ["string"
],
"syncOptions": ["string"
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": "string",
"value": "string"
}
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
}
},
"createdAt": "2019-08-24T14:15:22Z",
"lastModifiedAt": "2019-08-24T14:15:22Z",
"stale": true
}

UpdateSpec updates an 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 required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

Payload
curl
Java
Go

application/json

{"name": "string",
"spec": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": ["string"
],
"parameters": [{"name": "string",
"value": "string",
"forceString": true
}
],
"releaseName": "string",
"values": "string",
"fileParameters": [{"name": "string",
"path": "string"
}
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": ["string"
],
"commonLabels": {"property1": "string",
"property2": "string"
},
"version": "string",
"commonAnnotations": {"property1": "string",
"property2": "string"
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [{"count": "string",
"name": "string"
}
]
},
"ksonnet": {"environment": "string",
"parameters": [{"component": "string",
"name": "string",
"value": "string"
}
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [{"name": "string",
"value": "string",
"code": true
}
],
"tlas": [{"name": "string",
"value": "string",
"code": true
}
],
"libs": ["string"
]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [{"name": "string",
"value": "string"
}
]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
},
"project": "string",
"syncPolicy": {"automated": {"prune": true,
"selfHeal": true,
"allowEmpty": true
},
"syncOptions": ["string"
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"ignoreDifferences": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"jsonPointers": ["string"
],
"jqPathExpressions": ["string"
],
"managedFieldsManagers": ["string"
]
}
],
"info": [{"name": "string",
"value": "string"
}
],
"revisionHistoryLimit": "string"
},
"validate": true
}

Response samples

200
default

application/json

{"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": ["string"
],
"parameters": [{"name": "string",
"value": "string",
"forceString": true
}
],
"releaseName": "string",
"values": "string",
"fileParameters": [{"name": "string",
"path": "string"
}
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": ["string"
],
"commonLabels": {"property1": "string",
"property2": "string"
},
"version": "string",
"commonAnnotations": {"property1": "string",
"property2": "string"
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [{"count": "string",
"name": "string"
}
]
},
"ksonnet": {"environment": "string",
"parameters": [{"component": "string",
"name": "string",
"value": "string"
}
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [{"name": "string",
"value": "string",
"code": true
}
],
"tlas": [{"name": "string",
"value": "string",
"code": true
}
],
"libs": ["string"
]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [{"name": "string",
"value": "string"
}
]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
},
"project": "string",
"syncPolicy": {"automated": {"prune": true,
"selfHeal": true,
"allowEmpty": true
},
"syncOptions": ["string"
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"ignoreDifferences": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"jsonPointers": ["string"
],
"jqPathExpressions": ["string"
],
"managedFieldsManagers": ["string"
]
}
],
"info": [{"name": "string",
"value": "string"
}
],
"revisionHistoryLimit": "string"
}

Sync syncs an application to its target state Harness Event type (deploy)

Delete deletes an application.

Securityx-api-key

Request

path Parameters

agentIdentifier required	string Agent identifier for entity.
request.name required	string

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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)

Responses

200

A successful response.

default

An unexpected error response.

post/gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/sync

Request samples

Payload
curl
Java
Go

application/json

{"name": "string",
"revision": "string",
"dryRun": true,
"prune": true,
"strategy": {"apply": {"force": true
},
"hook": {"syncStrategyApply": {"force": true
}
}
},
"resources": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string"
}
],
"manifests": ["string"
],
"infos": [{"name": "string",
"value": "string"
}
],
"retryStrategy": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
},
"syncOptions": {"items": ["string"
]
}
}

Response samples

200
default

application/json

{"accountIdentifier": "string",
"orgIdentifier": "string",
"projectIdentifier": "string",
"agentIdentifier": "string",
"name": "string",
"clusterIdentifier": "string",
"repoIdentifier": "string",
"app": {"metadata": {"name": "string",
"generateName": "string",
"namespace": "string",
"selfLink": "string",
"uid": "string",
"resourceVersion": "string",
"generation": "string",
"creationTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionGracePeriodSeconds": "string",
"labels": {"property1": "string",
"property2": "string"
},
"annotations": {"property1": "string",
"property2": "string"
},
"ownerReferences": [{"apiVersion": "string",
"kind": "string",
"name": "string",
"uid": "string",
"controller": true,
"blockOwnerDeletion": true
}
],
"finalizers": ["string"
],
"clusterName": "string",
"managedFields": [{"manager": "string",
"operation": "string",
"apiVersion": "string",
"time": {"seconds": "string",
"nanos": 0
},
"fieldsType": "string",
"fieldsV1": {"Raw": "string"
},
"subresource": "string"
}
]
},
"spec": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": ["string"
],
"parameters": [{"name": "string",
"value": "string",
"forceString": true
}
],
"releaseName": "string",
"values": "string",
"fileParameters": [{"name": "string",
"path": "string"
}
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": ["string"
],
"commonLabels": {"property1": "string",
"property2": "string"
},
"version": "string",
"commonAnnotations": {"property1": "string",
"property2": "string"
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [{"count": "string",
"name": "string"
}
]
},
"ksonnet": {"environment": "string",
"parameters": [{"component": "string",
"name": "string",
"value": "string"
}
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [{"name": null,
"value": null,
"code": null
}
],
"tlas": [{"name": null,
"value": null,
"code": null
}
],
"libs": ["string"
]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [{"name": "string",
"value": "string"
}
]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
},
"project": "string",
"syncPolicy": {"automated": {"prune": true,
"selfHeal": true,
"allowEmpty": true
},
"syncOptions": ["string"
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"ignoreDifferences": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"jsonPointers": ["string"
],
"jqPathExpressions": ["string"
],
"managedFieldsManagers": ["string"
]
}
],
"info": [{"name": "string",
"value": "string"
}
],
"revisionHistoryLimit": "string"
},
"status": {"resources": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"status": "string",
"health": {"status": "string",
"message": "string"
},
"hook": true,
"requiresPruning": true
}
],
"sync": {"status": "string",
"comparedTo": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
}
},
"revision": "string"
},
"health": {"status": "string",
"message": "string"
},
"history": [{"revision": "string",
"deployedAt": {"seconds": "string",
"nanos": 0
},
"id": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
},
"deployStartedAt": {"seconds": "string",
"nanos": 0
},
"deployedAtTs": "2019-08-24T14:15:22Z",
"deployStartedAtTs": "2019-08-24T14:15:22Z"
}
],
"conditions": [{"type": "string",
"message": "string",
"lastTransitionTime": {"seconds": "string",
"nanos": 0
},
"lastTransitionTimeTs": "2019-08-24T14:15:22Z"
}
],
"reconciledAt": {"seconds": "string",
"nanos": 0
},
"operationState": {"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": {"force": null
},
"hook": {"syncStrategyApply": null
}
},
"resources": [{"group": null,
"kind": null,
"name": null,
"namespace": null
}
],
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [ ],
"parameters": [ ],
"releaseName": null,
"values": null,
"fileParameters": [ ],
"version": null,
"passCredentials": null
},
"kustomize": {"namePrefix": null,
"nameSuffix": null,
"images": [ ],
"commonLabels": { },
"version": null,
"commonAnnotations": { },
"forceCommonLabels": null,
"forceCommonAnnotations": null,
"namespace": null,
"replicas": [ ]
},
"ksonnet": {"environment": null,
"parameters": [ ]
},
"directory": {"recurse": null,
"jsonnet": null,
"exclude": null,
"include": null
},
"plugin": {"name": null,
"env": [ ]
},
"chart": "string"
},
"manifests": ["string"
],
"syncOptions": ["string"
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": "string",
"value": "string"
}
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"phase": "string",
"message": "string",
"syncResult": {"resources": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"status": "string",
"message": "string",
"hookType": "string",
"hookPhase": "string",
"syncPhase": "string"
}
],
"revision": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
}
},
"startedAt": {"seconds": "string",
"nanos": 0
},
"finishedAt": {"seconds": "string",
"nanos": 0
},
"retryCount": "string",
"startedAtTs": "2019-08-24T14:15:22Z",
"finishedAtTs": "2019-08-24T14:15:22Z"
},
"observedAt": {"seconds": "string",
"nanos": 0
},
"sourceType": "string",
"summary": {"externalURLs": ["string"
],
"images": ["string"
]
}
},
"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": {"force": true
},
"hook": {"syncStrategyApply": {"force": true
}
}
},
"resources": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string"
}
],
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": ["string"
],
"parameters": [{"name": null,
"value": null,
"forceString": null
}
],
"releaseName": "string",
"values": "string",
"fileParameters": [{"name": null,
"path": null
}
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": ["string"
],
"commonLabels": {"property1": "string",
"property2": "string"
},
"version": "string",
"commonAnnotations": {"property1": "string",
"property2": "string"
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [{"count": null,
"name": null
}
]
},
"ksonnet": {"environment": "string",
"parameters": [{"component": null,
"name": null,
"value": null
}
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [null
],
"tlas": [null
],
"libs": [null
]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [{"name": null,
"value": null
}
]
},
"chart": "string"
},
"manifests": ["string"
],
"syncOptions": ["string"
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": "string",
"value": "string"
}
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
}
},
"createdAt": "2019-08-24T14:15:22Z",
"lastModifiedAt": "2019-08-24T14:15:22Z",
"stale": true
}

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 required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

curl
Java
Go

Response samples

200
default

application/json

{"result": {"type": "string",
"application": {"metadata": {"name": "string",
"generateName": "string",
"namespace": "string",
"selfLink": "string",
"uid": "string",
"resourceVersion": "string",
"generation": "string",
"creationTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionTimestamp": {"seconds": "string",
"nanos": 0
},
"deletionGracePeriodSeconds": "string",
"labels": {"property1": "string",
"property2": "string"
},
"annotations": {"property1": "string",
"property2": "string"
},
"ownerReferences": [{"apiVersion": "string",
"kind": "string",
"name": "string",
"uid": "string",
"controller": true,
"blockOwnerDeletion": true
}
],
"finalizers": ["string"
],
"clusterName": "string",
"managedFields": [{"manager": "string",
"operation": "string",
"apiVersion": "string",
"time": {"seconds": "string",
"nanos": 0
},
"fieldsType": "string",
"fieldsV1": {"Raw": "string"
},
"subresource": "string"
}
]
},
"spec": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": ["string"
],
"parameters": [{"name": null,
"value": null,
"forceString": null
}
],
"releaseName": "string",
"values": "string",
"fileParameters": [{"name": null,
"path": null
}
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": ["string"
],
"commonLabels": {"property1": "string",
"property2": "string"
},
"version": "string",
"commonAnnotations": {"property1": "string",
"property2": "string"
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [{"count": null,
"name": null
}
]
},
"ksonnet": {"environment": "string",
"parameters": [{"component": null,
"name": null,
"value": null
}
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [null
],
"tlas": [null
],
"libs": [null
]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [{"name": null,
"value": null
}
]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
},
"project": "string",
"syncPolicy": {"automated": {"prune": true,
"selfHeal": true,
"allowEmpty": true
},
"syncOptions": ["string"
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"ignoreDifferences": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"jsonPointers": ["string"
],
"jqPathExpressions": ["string"
],
"managedFieldsManagers": ["string"
]
}
],
"info": [{"name": "string",
"value": "string"
}
],
"revisionHistoryLimit": "string"
},
"status": {"resources": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"status": "string",
"health": {"status": "string",
"message": "string"
},
"hook": true,
"requiresPruning": true
}
],
"sync": {"status": "string",
"comparedTo": {"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [ ],
"parameters": [ ],
"releaseName": null,
"values": null,
"fileParameters": [ ],
"version": null,
"passCredentials": null
},
"kustomize": {"namePrefix": null,
"nameSuffix": null,
"images": [ ],
"commonLabels": { },
"version": null,
"commonAnnotations": { },
"forceCommonLabels": null,
"forceCommonAnnotations": null,
"namespace": null,
"replicas": [ ]
},
"ksonnet": {"environment": null,
"parameters": [ ]
},
"directory": {"recurse": null,
"jsonnet": null,
"exclude": null,
"include": null
},
"plugin": {"name": null,
"env": [ ]
},
"chart": "string"
},
"destination": {"server": "string",
"namespace": "string",
"name": "string"
}
},
"revision": "string"
},
"health": {"status": "string",
"message": "string"
},
"history": [{"revision": "string",
"deployedAt": {"seconds": "string",
"nanos": 0
},
"id": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [ ],
"parameters": [ ],
"releaseName": null,
"values": null,
"fileParameters": [ ],
"version": null,
"passCredentials": null
},
"kustomize": {"namePrefix": null,
"nameSuffix": null,
"images": [ ],
"commonLabels": { },
"version": null,
"commonAnnotations": { },
"forceCommonLabels": null,
"forceCommonAnnotations": null,
"namespace": null,
"replicas": [ ]
},
"ksonnet": {"environment": null,
"parameters": [ ]
},
"directory": {"recurse": null,
"jsonnet": null,
"exclude": null,
"include": null
},
"plugin": {"name": null,
"env": [ ]
},
"chart": "string"
},
"deployStartedAt": {"seconds": "string",
"nanos": 0
},
"deployedAtTs": "2019-08-24T14:15:22Z",
"deployStartedAtTs": "2019-08-24T14:15:22Z"
}
],
"conditions": [{"type": "string",
"message": "string",
"lastTransitionTime": {"seconds": "string",
"nanos": 0
},
"lastTransitionTimeTs": "2019-08-24T14:15:22Z"
}
],
"reconciledAt": {"seconds": "string",
"nanos": 0
},
"operationState": {"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": null,
"hook": null
},
"resources": [null
],
"source": {"repoURL": null,
"path": null,
"targetRevision": null,
"helm": null,
"kustomize": null,
"ksonnet": null,
"directory": null,
"plugin": null,
"chart": null
},
"manifests": [null
],
"syncOptions": [null
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": null,
"value": null
}
],
"retry": {"limit": "string",
"backoff": {"duration": null,
"factor": null,
"maxDuration": null
}
}
},
"phase": "string",
"message": "string",
"syncResult": {"resources": [{"group": null,
"version": null,
"kind": null,
"namespace": null,
"name": null,
"status": null,
"message": null,
"hookType": null,
"hookPhase": null,
"syncPhase": null
}
],
"revision": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [ ],
"parameters": [ ],
"releaseName": null,
"values": null,
"fileParameters": [ ],
"version": null,
"passCredentials": null
},
"kustomize": {"namePrefix": null,
"nameSuffix": null,
"images": [ ],
"commonLabels": { },
"version": null,
"commonAnnotations": { },
"forceCommonLabels": null,
"forceCommonAnnotations": null,
"namespace": null,
"replicas": [ ]
},
"ksonnet": {"environment": null,
"parameters": [ ]
},
"directory": {"recurse": null,
"jsonnet": null,
"exclude": null,
"include": null
},
"plugin": {"name": null,
"env": [ ]
},
"chart": "string"
}
},
"startedAt": {"seconds": "string",
"nanos": 0
},
"finishedAt": {"seconds": "string",
"nanos": 0
},
"retryCount": "string",
"startedAtTs": "2019-08-24T14:15:22Z",
"finishedAtTs": "2019-08-24T14:15:22Z"
},
"observedAt": {"seconds": "string",
"nanos": 0
},
"sourceType": "string",
"summary": {"externalURLs": ["string"
],
"images": ["string"
]
}
},
"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": {"force": true
},
"hook": {"syncStrategyApply": {"force": null
}
}
},
"resources": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string"
}
],
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
},
"manifests": ["string"
],
"syncOptions": ["string"
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": "string",
"value": "string"
}
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
}
}
},
"error": {"grpc_code": 0,
"http_code": 0,
"message": "string",
"http_status": "string",
"details": [{"type_url": "string",
"value": "string"
}
]
}
}

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 required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

curl
Java
Go

Response samples

200
default

application/json

{"result": {"nodes": [{"resourceRef": {"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"uid": "string"
},
"parentRefs": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"uid": "string"
}
],
"info": [{"name": "string",
"value": "string"
}
],
"networkingInfo": {"targetLabels": {"property1": "string",
"property2": "string"
},
"targetRefs": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"uid": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"ingress": [{"ip": "string",
"hostname": "string",
"ports": [null
]
}
],
"externalURLs": ["string"
]
},
"resourceVersion": "string",
"images": ["string"
],
"health": {"status": "string",
"message": "string"
},
"createdAt": {"seconds": "string",
"nanos": 0
}
}
],
"orphanedNodes": [{"resourceRef": {"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"uid": "string"
},
"parentRefs": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"uid": "string"
}
],
"info": [{"name": "string",
"value": "string"
}
],
"networkingInfo": {"targetLabels": {"property1": "string",
"property2": "string"
},
"targetRefs": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"uid": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"ingress": [{"ip": "string",
"hostname": "string",
"ports": [null
]
}
],
"externalURLs": ["string"
]
},
"resourceVersion": "string",
"images": ["string"
],
"health": {"status": "string",
"message": "string"
},
"createdAt": {"seconds": "string",
"nanos": 0
}
}
],
"hosts": [{"name": "string",
"resourcesInfo": [{"resourceName": "string",
"requestedByApp": "string",
"requestedByNeighbors": "string",
"capacity": "string"
}
],
"systemInfo": {"machineID": "string",
"systemUUID": "string",
"bootID": "string",
"kernelVersion": "string",
"osImage": "string",
"containerRuntimeVersion": "string",
"kubeletVersion": "string",
"kubeProxyVersion": "string",
"operatingSystem": "string",
"architecture": "string"
}
}
]
},
"error": {"grpc_code": 0,
"http_code": 0,
"message": "string",
"http_status": "string",
"details": [{"type_url": "string",
"value": "string"
}
]
}
}

ListNs returns list of namespaces for a query.

List returns list of namespaces for a specific agent.

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

Payload
curl
Java
Go

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": ["string"
]
}

Response samples

200
default

application/json

{"namespaces": [{"name": "string"
}
],
"totalPages": 0,
"totalItems": 0,
"pageItemCount": 0,
"pageSize": 0,
"pageIndex": 0,
"empty": true
}

List returns 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

Payload
curl
Java
Go

application/json

{"accountIdentifier": "string",
"projectIdentifier": "string",
"orgIdentifier": "string",
"agentIdentifier": "string",
"applicationName": "string",
"searchTerm": "string",
"pageSize": 0,
"pageIndex": 0,
"endTime": 0,
"startTime": 0,
"operationPhase": ["OPERATION_PHASE_UNSET"
]
}

Response samples

200
default

application/json

{"content": [{"accountIdentifier": "string",
"projectIdentifier": "string",
"orgIdentifier": "string",
"agentIdentifier": "string",
"applicationName": "string",
"createdAt": "string",
"lastModifiedAt": "string",
"operationState": {"operation": {"sync": {"revision": "string",
"prune": true,
"dryRun": true,
"syncStrategy": {"apply": {"force": null
},
"hook": {"syncStrategyApply": null
}
},
"resources": [{"group": null,
"kind": null,
"name": null,
"namespace": null
}
],
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [ ],
"parameters": [ ],
"releaseName": null,
"values": null,
"fileParameters": [ ],
"version": null,
"passCredentials": null
},
"kustomize": {"namePrefix": null,
"nameSuffix": null,
"images": [ ],
"commonLabels": { },
"version": null,
"commonAnnotations": { },
"forceCommonLabels": null,
"forceCommonAnnotations": null,
"namespace": null,
"replicas": [ ]
},
"ksonnet": {"environment": null,
"parameters": [ ]
},
"directory": {"recurse": null,
"jsonnet": null,
"exclude": null,
"include": null
},
"plugin": {"name": null,
"env": [ ]
},
"chart": "string"
},
"manifests": ["string"
],
"syncOptions": ["string"
]
},
"initiatedBy": {"username": "string",
"automated": true
},
"info": [{"name": "string",
"value": "string"
}
],
"retry": {"limit": "string",
"backoff": {"duration": "string",
"factor": "string",
"maxDuration": "string"
}
}
},
"phase": "string",
"message": "string",
"syncResult": {"resources": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"status": "string",
"message": "string",
"hookType": "string",
"hookPhase": "string",
"syncPhase": "string"
}
],
"revision": "string",
"source": {"repoURL": "string",
"path": "string",
"targetRevision": "string",
"helm": {"valueFiles": [null
],
"parameters": [null
],
"releaseName": "string",
"values": "string",
"fileParameters": [null
],
"version": "string",
"passCredentials": true
},
"kustomize": {"namePrefix": "string",
"nameSuffix": "string",
"images": [null
],
"commonLabels": {"property1": null,
"property2": null
},
"version": "string",
"commonAnnotations": {"property1": null,
"property2": null
},
"forceCommonLabels": true,
"forceCommonAnnotations": true,
"namespace": "string",
"replicas": [null
]
},
"ksonnet": {"environment": "string",
"parameters": [null
]
},
"directory": {"recurse": true,
"jsonnet": {"extVars": [ ],
"tlas": [ ],
"libs": [ ]
},
"exclude": "string",
"include": "string"
},
"plugin": {"name": "string",
"env": [null
]
},
"chart": "string"
}
},
"startedAt": {"seconds": "string",
"nanos": 0
},
"finishedAt": {"seconds": "string",
"nanos": 0
},
"retryCount": "string",
"startedAtTs": "2019-08-24T14:15:22Z",
"finishedAtTs": "2019-08-24T14:15:22Z"
},
"reqIdentifier": "string",
"lastKnownRevisionId": "string",
"syncedBy": {"id": "string",
"name": "string",
"email": "string"
}
}
],
"totalPages": 0,
"totalItems": 0,
"pageItemCount": 0,
"pageSize": 0,
"pageIndex": 0,
"empty": true
}

Checks whether an app with the given name exists

Securityx-api-key

Request

path Parameters

name

required

string

query Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	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

curl
Java
Go

Response samples

200
default

application/json

true

➔ Next to Certificates

Applications

List returns list of applications for a specific agent

path Parameters

query Parameters

Create creates an application

path Parameters

query Parameters

Request Body schema: application/jsonrequired

ManagedResources returns list of managed resources

path Parameters

query Parameters

Get returns an application by name

path Parameters

query Parameters

ListResourceEvents returns a list of event resources

path Parameters

query Parameters

PodLogs returns stream of log entries for the specified pod(s).

path Parameters

query Parameters

GetManifests returns application manifests

path Parameters

query Parameters

PodLogs returns stream of log entries for the specified pod(s).

path Parameters

query Parameters

ResourceTree returns resource tree

path Parameters

query Parameters

Get the meta-data (author, date, tags, message) for a specific revision of the application

path Parameters

query Parameters

Get returns sync windows of the application

path Parameters

query Parameters

Update updates an application

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Delete deletes an application

path Parameters

query Parameters

Patch patch an application

path Parameters

Request Body schema: application/jsonrequired

TerminateOperation terminates the currently running operation

path Parameters

query Parameters

GetResource returns single application resource

path Parameters

query Parameters

DeleteResource deletes a single application resource

path Parameters

query Parameters

PatchResource patch single application resource

path Parameters

query Parameters

Request Body schema: application/jsonrequired

ListResourceActions returns list of resource actions

path Parameters

query Parameters

RunResourceAction run resource action

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Rollback syncs an application to its target state Harness Event type (rollback)

path Parameters

query Parameters

Request Body schema: application/jsonrequired

UpdateSpec updates an application spec

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Sync syncs an application to its target state Harness Event type (deploy)

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Watch returns stream of application change events

path Parameters

query Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required