Projects

Create a new project

Create a new 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.

Request Body schema: application/json
object (AppProject provides a logical grouping of applications, providing controls for: * where the apps may deploy to (cluster whitelist) * what may be deployed (repository whitelist, resource whitelist/blacklist) * who can access these applications (roles, OIDC group claims bindings) * and what they can do (RBAC policies) * automation access to these roles (JWT tokens) +genclient +genclient:noStatus +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +kubebuilder:resource:path=appprojects,shortName=appproj;appprojs)
upsert
boolean
Responses
200

A successful response.

default

An unexpected error response.

post/gitops/api/v1/agents/{agentIdentifier}/projects
Request samples
application/json
{
  • "project": {
    },
  • "upsert": true
}
Response samples
application/json
{
  • "metadata": {
    },
  • "spec": {
    },
  • "status": {
    }
}

Delete deletes a project

Delete deletes a project.

SecurityApiKey
Request
path Parameters
agentIdentifier
required
string

Agent identifier for entity.

query.name
required
string
query Parameters
accountIdentifier
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

Responses
200

A successful response.

default

An unexpected error response.

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

Get returns a project by name

Get returns an argo project by name.

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
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

Responses
200

A successful response.

default

An unexpected error response.

get/gitops/api/v1/agents/{agentIdentifier}/projects/{query.name}
Request samples
Response samples
application/json
{
  • "metadata": {
    },
  • "spec": {
    },
  • "status": {
    }
}

List returns list of projects

Lists lists argo projects.

SecurityApiKey
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.

query.name
string
Responses
200

A successful response.

default

An unexpected error response.

get/gitops/api/v1/agents/{agentIdentifier}/projects
Request samples
Response samples
application/json
{
  • "metadata": {
    },
  • "items": [
    ]
}

Update updates a project

Update updates a project.

SecurityApiKey
Request
path Parameters
agentIdentifier
required
string

Agent identifier for entity.

request.project.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
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

Request Body schema: application/json
object (AppProject provides a logical grouping of applications, providing controls for: * where the apps may deploy to (cluster whitelist) * what may be deployed (repository whitelist, resource whitelist/blacklist) * who can access these applications (roles, OIDC group claims bindings) * and what they can do (RBAC policies) * automation access to these roles (JWT tokens) +genclient +genclient:noStatus +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +kubebuilder:resource:path=appprojects,shortName=appproj;appprojs)
Responses
200

A successful response.

default

An unexpected error response.

put/gitops/api/v1/agents/{agentIdentifier}/projects/{request.project.metadata.name}
Request samples
application/json
{
  • "project": {
    }
}
Response samples
application/json
{
  • "metadata": {
    },
  • "spec": {
    },
  • "status": {
    }
}