Applications

Checks whether an app with the given name exists

Checks whether an app with the given name exists

SecurityApiKey
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
Response samples
application/json
true

Create creates an application

Creates application in project.

SecurityApiKey
Request
path Parameters
agentIdentifier
required
string

Agent identifier for entity.

query Parameters
accountIdentifier
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

clusterIdentifier
string
repoIdentifier
string
Request Body schema: application/json
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
Responses
200

A successful response.

default

An unexpected error response.

post/gitops/api/v1/agents/{agentIdentifier}/applications
Request samples
application/json
{
  • "application": {
    },
  • "upsert": true,
  • "validate": true,
  • "project": "string"
}
Response samples
application/json
{
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "agentIdentifier": "string",
  • "name": "string",
  • "clusterIdentifier": "string",
  • "repoIdentifier": "string",
  • "app": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastModifiedAt": "2019-08-24T14:15:22Z",
  • "stale": true
}

Delete deletes an application

Delete deletes an application.

SecurityApiKey
Request
path Parameters
agentIdentifier
required
string

Agent identifier for entity.

request.name
required
string
query Parameters
accountIdentifier
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

request.cascade
boolean
request.propagationPolicy
string
options.removeExistingFinalizers
boolean
Responses
200

A successful response.

default

An unexpected error response.

delete/gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}
Request samples
Response samples
application/json
{ }

DeleteResource deletes a single application resource

DeleteResource deletes a single application resource.

SecurityApiKey
Request
path Parameters
agentIdentifier
required
string

Agent identifier for entity.

request.name
required
string
query Parameters
accountIdentifier
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

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

A successful response.

default

An unexpected error response.

delete/gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/resource
Request samples
Response samples
application/json
{ }

Get returns an application by name

Get returns an application by name

SecurityApiKey
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
Response samples
application/json
{
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "agentIdentifier": "string",
  • "name": "string",
  • "clusterIdentifier": "string",
  • "repoIdentifier": "string",
  • "app": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastModifiedAt": "2019-08-24T14:15:22Z",
  • "stale": true
}

Get returns sync windows of the application

GetApplicationSyncWindows returns sync windows of the application.

SecurityApiKey
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
Response samples
application/json
{
  • "activeWindows": [
    ],
  • "assignedWindows": [
    ],
  • "canSync": true
}

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.

SecurityApiKey
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
Response samples
application/json
{
  • "author": "string",
  • "date": {
    },
  • "tags": [
    ],
  • "message": "string",
  • "signatureInfo": "string"
}

GetManifests returns application manifests

GetManifests returns application manifests.

SecurityApiKey
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
Response samples
application/json
{
  • "manifests": [
    ],
  • "namespace": "string",
  • "server": "string",
  • "revision": "string",
  • "sourceType": "string",
  • "verifyResult": "string"
}

GetResource returns single application resource

GetResource returns single application resource.

SecurityApiKey
Request
path Parameters
agentIdentifier
required
string

Agent identifier for entity.

request.name
required
string
query Parameters
accountIdentifier
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

request.namespace
string
request.resourceName
string
request.version
string
request.group
string
request.kind
string
Responses
200

A successful response.

default

An unexpected error response.

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

List returns list of application sync status

List returns list of application sync status

SecurityApiKey
Request
Request Body schema: application/json
accountIdentifier
string

Account Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

agentIdentifier
string

Agent identifier for entity.

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

A successful response.

default

An unexpected error response.

post/gitops/api/v1/applications/sync
Request samples
application/json
{
  • "accountIdentifier": "string",
  • "projectIdentifier": "string",
  • "orgIdentifier": "string",
  • "agentIdentifier": "string",
  • "applicationName": "string",
  • "searchTerm": "string",
  • "pageSize": 0,
  • "pageIndex": 0,
  • "endTime": 0,
  • "startTime": 0,
  • "operationPhase": [
    ]
}
Response samples
application/json
{
  • "content": [
    ],
  • "totalPages": 0,
  • "totalItems": 0,
  • "pageItemCount": 0,
  • "pageSize": 0,
  • "pageIndex": 0,
  • "empty": true
}

List returns list of applications for a specific agent

List returns list of applications for a specific agent.

SecurityApiKey
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
Response samples
application/json
{
  • "metadata": {
    },
  • "items": [