Application

List applications

ListApps retrieves a list of applications.

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

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

{"content": [{"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"
],
"managedFields": [{"manager": "string",
"operation": "string",
"apiVersion": "string",
"time": {"seconds": null,
"nanos": null
},
"fieldsType": "string",
"fieldsV1": {"Raw": null
},
"subresource": "string"
}
]
},
"spec": {"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",
"ref": "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": null,
"factor": null,
"maxDuration": null
}
}
},
"ignoreDifferences": [{"group": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"jsonPointers": [null
],
"jqPathExpressions": [null
],
"managedFieldsManagers": [null
]
}
],
"info": [{"name": "string",
"value": "string"
}
],
"revisionHistoryLimit": "string",
"sources": [{"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",
"ref": "string"
}
]
},
"status": {"resources": [{"group": "string",
"version": "string",
"kind": "string",
"namespace": "string",
"name": "string",
"status": "string",
"health": {"status": null,
"message": null
},
"hook": true,
"requiresPruning": true
}
],
"sync": {"status": "string",
"comparedTo": {"source": {"repoURL": null,
"path": null,
"targetRevision": null,
"helm": null,
"kustomize": null,
"ksonnet": null,
"directory": null,
"plugin": null,
"chart": null,
"ref": null
},
"destination": {"server": null,
"namespace": null,
"name": null
},
"sources": [null
],
"ignoreDifferences": [null
]
},
"revision": "string"
},
"health": {"status": "string",
"message": "string"
},
"history": [{"revision": "string",
"deployedAt": {"seconds": null,
"nanos": null
},
"id": "string",
"source": {"repoURL": null,
"path": null,
"targetRevision": null,
"helm": null,
"kustomize": null,
"ksonnet": null,
"directory": null,
"plugin": null,
"chart": null,
"ref": null
},
"deployStartedAt": {"seconds": null,
"nanos": null
},
"deployedAtTs": "2019-08-24T14:15:22Z",
"deployStartedAtTs": "2019-08-24T14:15:22Z",
"sources": [null
],
"revisions": [null
],
"initiatedBy": {"username": null,
"automated": null
}
}
],
"conditions": [{"type": "string",
"message": "string",
"lastTransitionTime": {"seconds": null,
"nanos": null
},
"lastTransitionTimeTs": "2019-08-24T14:15:22Z"
}
],
"reconciledAt": {"seconds": "string",
"nanos": 0
},
"operationState": {"operation": {"sync": {"revision": null,
"prune": null,
"dryRun": null,
"syncStrategy": null,
"resources": [ ],
"source": null,
"manifests": [ ],
"syncOptions": [ ],
"sources": [ ],
"revisions": [ ]
},
"initiatedBy": {"username": null,
"automated": null
},
"info": [null
],
"retry": {"limit": null,
"backoff": null
}
},
"phase": "string",
"message": "string",
"syncResult": {"resources": [null
],
"revision": "string",
"source": {"repoURL": null,
"path": null,
"targetRevision": null,
"helm": null,
"kustomize": null,
"ksonnet": null,
"directory": null,
"plugin": null,
"chart": null,
"ref": null
},
"sources": [null
],
"revisions": [null
]
},
"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"
]
},
"resourceHealthSource": "string",
"sourceTypes": ["string"
],
"controllerNamespace": "string"
},
"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",
"ref": "string"
},
"manifests": ["string"
],
"syncOptions": ["string"
],
"sources": [{"repoURL": null,
"path": null,
"targetRevision": null,
"helm": null,
"kustomize": null,
"ksonnet": null,
"directory": null,
"plugin": null,
"chart": null,
"ref": null
}
],
"revisions": ["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,
"skipRepoValidation": true,
"repoIdentifiers": ["string"
],
"parentAppRef": "string"
}
],
"totalPages": 0,
"totalItems": 0,
"pageItemCount": 0,
"pageSize": 0,
"pageIndex": 0,
"empty": true
}

➔ Next to Applications

Application

List applications

Request Body schema: application/jsonrequired

Request Body schema: application/json
required