Argo CD ProjectService API
The ProjectService API from Argo CD — 10 operation(s) for projectservice.
The ProjectService API from Argo CD — 10 operation(s) for projectservice.
swagger: '2.0'
info:
description: Description of all APIs
title: Consolidate Services AccountService ProjectService API
version: version not set
consumes:
- application/json
produces:
- application/json
tags:
- name: ProjectService
paths:
/api/v1/projects:
get:
tags:
- ProjectService
summary: List returns list of projects
operationId: ProjectService_List
parameters:
- type: string
name: name
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/v1alpha1AppProjectList'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
post:
tags:
- ProjectService
summary: Create a new project
operationId: ProjectService_Create
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/projectProjectCreateRequest'
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/v1alpha1AppProject'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/projects/{name}:
get:
tags:
- ProjectService
summary: Get returns a project by name
operationId: ProjectService_Get
parameters:
- type: string
name: name
in: path
required: true
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/v1alpha1AppProject'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
delete:
tags:
- ProjectService
summary: Delete deletes a project
operationId: ProjectService_Delete
parameters:
- type: string
name: name
in: path
required: true
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/projectEmptyResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/projects/{name}/detailed:
get:
tags:
- ProjectService
summary: GetDetailedProject returns a project that include project, global project and scoped resources by name
operationId: ProjectService_GetDetailedProject
parameters:
- type: string
name: name
in: path
required: true
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/projectDetailedProjectsResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/projects/{name}/events:
get:
tags:
- ProjectService
summary: ListEvents returns a list of project events
operationId: ProjectService_ListEvents
parameters:
- type: string
name: name
in: path
required: true
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/v1EventList'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/projects/{name}/globalprojects:
get:
tags:
- ProjectService
summary: Get returns a virtual project by name
operationId: ProjectService_GetGlobalProjects
parameters:
- type: string
name: name
in: path
required: true
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/projectGlobalProjectsResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/projects/{name}/links:
get:
tags:
- ProjectService
summary: ListLinks returns all deep links for the particular project
operationId: ProjectService_ListLinks
parameters:
- type: string
name: name
in: path
required: true
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/applicationLinksResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/projects/{name}/syncwindows:
get:
tags:
- ProjectService
summary: GetSchedulesState returns true if there are any active sync syncWindows
operationId: ProjectService_GetSyncWindowsState
parameters:
- type: string
name: name
in: path
required: true
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/projectSyncWindowsResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/projects/{project.metadata.name}:
put:
tags:
- ProjectService
summary: Update updates a project
operationId: ProjectService_Update
parameters:
- type: string
description: '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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
+optional'
name: project.metadata.name
in: path
required: true
- name: body
in: body
required: true
schema:
$ref: '#/definitions/projectProjectUpdateRequest'
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/v1alpha1AppProject'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/projects/{project}/roles/{role}/token:
post:
tags:
- ProjectService
summary: Create a new project token
operationId: ProjectService_CreateToken
parameters:
- type: string
name: project
in: path
required: true
- type: string
name: role
in: path
required: true
- name: body
in: body
required: true
schema:
$ref: '#/definitions/projectProjectTokenCreateRequest'
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/projectProjectTokenResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
/api/v1/projects/{project}/roles/{role}/token/{iat}:
delete:
tags:
- ProjectService
summary: Delete a new project token
operationId: ProjectService_DeleteToken
parameters:
- type: string
name: project
in: path
required: true
- type: string
name: role
in: path
required: true
- type: string
format: int64
name: iat
in: path
required: true
- type: string
name: id
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/projectEmptyResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/runtimeError'
definitions:
v1alpha1SourceIntegrityGitPolicy:
type: object
properties:
gpg:
$ref: '#/definitions/v1alpha1SourceIntegrityGitPolicyGPG'
repos:
type: array
title: List of repository criteria restricting repositories the policy will apply to
items:
$ref: '#/definitions/v1alpha1SourceIntegrityGitPolicyRepo'
v1alpha1Repository:
type: object
title: Repository is a repository holding application configurations
properties:
azureActiveDirectoryEndpoint:
type: string
title: AzureActiveDirectoryEndpoint specifies the Azure Active Directory endpoint used for Service Principal authentication. If empty will default to https://login.microsoftonline.com
azureServicePrincipalClientId:
type: string
title: AzureServicePrincipalClientId specifies the client ID of the Azure Service Principal used to access the repo
azureServicePrincipalClientSecret:
type: string
title: AzureServicePrincipalClientSecret specifies the client secret of the Azure Service Principal used to access the repo
azureServicePrincipalTenantId:
type: string
title: AzureServicePrincipalTenantId specifies the tenant ID of the Azure Service Principal used to access the repo
bearerToken:
type: string
title: BearerToken contains the bearer token used for Git BitBucket Data Center auth at the repo server
connectionState:
$ref: '#/definitions/v1alpha1ConnectionState'
depth:
description: Depth specifies the depth for shallow clones. A value of 0 or omitting the field indicates a full clone.
type: integer
format: int64
enableLfs:
description: EnableLFS specifies whether git-lfs support should be enabled for this repo. Only valid for Git repositories.
type: boolean
enableOCI:
type: boolean
title: EnableOCI specifies whether helm-oci support should be enabled for this repo
forceHttpBasicAuth:
type: boolean
title: ForceHttpBasicAuth specifies whether Argo CD should attempt to force basic auth for HTTP connections
gcpServiceAccountKey:
type: string
title: GCPServiceAccountKey specifies the service account key in JSON format to be used for getting credentials to Google Cloud Source repos
githubAppEnterpriseBaseUrl:
type: string
title: GithubAppEnterpriseBaseURL specifies the base URL of GitHub Enterprise installation. If empty will default to https://api.github.com
githubAppID:
type: integer
format: int64
title: GithubAppId specifies the ID of the GitHub app used to access the repo
githubAppInstallationID:
type: integer
format: int64
title: GithubAppInstallationId specifies the installation ID of the GitHub App used to access the repo
githubAppPrivateKey:
type: string
title: Github App Private Key PEM data
inheritedCreds:
type: boolean
title: Whether credentials were inherited from a credential set
insecure:
type: boolean
title: Insecure specifies whether the connection to the repository ignores any errors when verifying TLS certificates or SSH host keys
insecureIgnoreHostKey:
type: boolean
title: 'InsecureIgnoreHostKey should not be used anymore, Insecure is favoured
Used only for Git repos'
insecureOCIForceHttp:
description: InsecureOCIForceHttp specifies whether the connection to the repository uses TLS at _all_. If true, no TLS. This flag is applicable for OCI repos only.
type: boolean
name:
type: string
title: Name specifies a name to be used for this repo. Only used with Helm repos
noProxy:
type: string
title: NoProxy specifies a list of targets where the proxy isn't used, applies only in cases where the proxy is applied
password:
type: string
title: Password contains the password or PAT used for authenticating at the remote repository
project:
type: string
title: Reference between project and repository that allows it to be automatically added as an item inside SourceRepos project entity
proxy:
type: string
title: Proxy specifies the HTTP/HTTPS proxy used to access the repo
repo:
type: string
title: Repo contains the URL to the remote repository
sshPrivateKey:
description: SSHPrivateKey contains the PEM data for authenticating at the repo server. Only used with Git repos.
type: string
tlsClientCertData:
type: string
title: TLSClientCertData contains a certificate in PEM format for authenticating at the repo server
tlsClientCertKey:
type: string
title: TLSClientCertKey contains a private key in PEM format for authenticating at the repo server
type:
description: Type specifies the type of the repo. Can be either "git" or "helm. "git" is assumed if empty or absent.
type: string
useAzureWorkloadIdentity:
type: boolean
title: UseAzureWorkloadIdentity specifies whether to use Azure Workload Identity for authentication
username:
type: string
title: Username contains the user name used for authenticating at the remote repository
webhookManifestCacheWarmDisabled:
description: 'WebhookManifestCacheWarmDisabled disables manifest cache warming during webhook processing for this repository.
When set, webhook handlers will only trigger reconciliation for affected applications and skip Redis cache
operations for unaffected ones. Recommended for large monorepos with plain YAML manifests.'
type: boolean
applicationLinksResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/definitions/applicationLinkInfo'
v1FieldsV1:
description: 'FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.
Each key is either a ''.'' representing the field itself, and will always map to an empty set,
or a string representing a sub-field or item. The string will follow one of these four formats:
''f:<name>'', where <name> is the name of a field in a struct, or key in a map
''v:<value>'', where <value> is the exact json formatted value of a list item
''i:<index>'', where <index> is position of a item in a list
''k:<keys>'', where <keys> is a map of a list item''s key fields to their unique values
If a key maps to an empty Fields value, the field that key represents is part of the set.
The exact format is defined in sigs.k8s.io/structured-merge-diff
+protobuf.options.(gogoproto.goproto_stringer)=false'
type: object
properties:
Raw:
description: Raw is the underlying serialization of this object.
type: string
format: byte
v1alpha1SourceIntegrityGitPolicyGPG:
description: 'SourceIntegrityGitPolicyGPG verifies that the commit(s) are both correctly signed by a key in the repo-server keyring,
and that they are signed by one of the key listed in Keys.
This policy can be deactivated through the ARGOCD_GPG_ENABLED environment variable.
Note the listing of problematic commits/signatures reported when "strict" mode validation fails may not be complete.
This means that a user that has addressed all problems reported by source integrity check can run into
further problematic signatures on a subsequent attempt. That happens namely when history contains seal commits signed
with gpg keys that are in the keyring, but not listed in Keys.'
type: object
properties:
keys:
description: List of key IDs to trust. The keys need to be in the repository server keyring.
type: array
items:
type: string
mode:
type: string
v1alpha1AppProjectSpec:
type: object
title: AppProjectSpec is the specification of an AppProject
properties:
clusterResourceBlacklist:
type: array
title: ClusterResourceBlacklist contains list of blacklisted cluster level resources
items:
$ref: '#/definitions/v1alpha1ClusterResourceRestrictionItem'
clusterResourceWhitelist:
type: array
title: ClusterResourceWhitelist contains list of whitelisted cluster level resources
items:
$ref: '#/definitions/v1alpha1ClusterResourceRestrictionItem'
description:
type: string
title: 'Description contains optional project description
+kubebuilder:validation:MaxLength=255'
destinationServiceAccounts:
description: DestinationServiceAccounts holds information about the service accounts to be impersonated for the application sync operation for each destination.
type: array
items:
$ref: '#/definitions/v1alpha1ApplicationDestinationServiceAccount'
destinations:
type: array
title: Destinations contains list of destinations available for deployment
items:
$ref: '#/definitions/v1alpha1ApplicationDestination'
namespaceResourceBlacklist:
type: array
title: NamespaceResourceBlacklist contains list of blacklisted namespace level resources
items:
$ref: '#/definitions/v1GroupKind'
namespaceResourceWhitelist:
type: array
title: NamespaceResourceWhitelist contains list of whitelisted namespace level resources
items:
$ref: '#/definitions/v1GroupKind'
orphanedResources:
$ref: '#/definitions/v1alpha1OrphanedResourcesMonitorSettings'
permitOnlyProjectScopedClusters:
type: boolean
title: PermitOnlyProjectScopedClusters determines whether destinations can only reference clusters which are project-scoped
roles:
type: array
title: Roles are user defined RBAC roles associated with this project
items:
$ref: '#/definitions/v1alpha1ProjectRole'
signatureKeys:
description: 'Deprecated: Use SourceIntegrity instead. SignatureKeys will be removed with the next major version.'
type: array
title: SignatureKeys contains a list of PGP key IDs that commits in Git must be signed with in order to be allowed for sync
items:
$ref: '#/definitions/v1alpha1SignatureKey'
sourceIntegrity:
$ref: '#/definitions/v1alpha1SourceIntegrity'
sourceNamespaces:
type: array
title: SourceNamespaces defines the namespaces application resources are allowed to be created in
items:
type: string
sourceRepos:
type: array
title: SourceRepos contains list of repository URLs which can be used for deployment
items:
type: string
syncWindows:
type: array
title: SyncWindows controls when syncs can be run for apps in this project
items:
$ref: '#/definitions/v1alpha1SyncWindow'
v1alpha1SourceIntegrity:
type: object
properties:
git:
$ref: '#/definitions/v1alpha1SourceIntegrityGit'
v1alpha1ClusterConfig:
description: 'ClusterConfig is the configuration attributes. This structure is subset of the go-client
rest.Config with annotations added for marshalling.'
type: object
properties:
awsAuthConfig:
$ref: '#/definitions/v1alpha1AWSAuthConfig'
bearerToken:
description: 'Server requires Bearer authentication. This client will not attempt to use
refresh tokens for an OAuth2 flow.
TODO: demonstrate an OAuth2 compatible client.'
type: string
disableCompression:
description: DisableCompression bypasses automatic GZip compression requests to the server.
type: boolean
execProviderConfig:
$ref: '#/definitions/v1alpha1ExecProviderConfig'
password:
type: string
proxyUrl:
type: string
title: ProxyURL is the URL to the proxy to be used for all requests send to the server
tlsClientConfig:
$ref: '#/definitions/v1alpha1TLSClientConfig'
username:
type: string
title: Server requires Basic authentication
projectGlobalProjectsResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/definitions/v1alpha1AppProject'
v1alpha1SyncWindow:
type: object
title: SyncWindow contains the kind, time, duration and attributes that are used to assign the syncWindows to apps
properties:
andOperator:
type: boolean
title: UseAndOperator use AND operator for matching applications, namespaces and clusters instead of the default OR operator
applications:
type: array
title: Applications contains a list of applications that the window will apply to
items:
type: string
clusters:
type: array
title: Clusters contains a list of clusters that the window will apply to
items:
type: string
description:
type: string
title: Description of the sync that will be applied to the schedule, can be used to add any information such as a ticket number for example
duration:
type: string
title: Duration is the amount of time the sync window will be open
kind:
type: string
title: Kind defines if the window allows or blocks syncs
manualSync:
type: boolean
title: ManualSync enables manual syncs when they would otherwise be blocked
namespaces:
type: array
title: Namespaces contains a list of namespaces that the window will apply to
items:
type: string
schedule:
type: string
title: Schedule is the time the window will begin, specified in cron format
syncOverrun:
type: boolean
title: 'SyncOverrun allows ongoing syncs to continue in two scenarios:
For deny windows: allows syncs that started before the deny window became active to continue running
For allow windows: allows syncs that started during the allow window to continue after the window ends'
timeZone:
type: string
title: TimeZone of the sync that will be applied to the schedule
v1EventSeries:
description: 'EventSeries contain information on series of events, i.e. thing that was/is happening
continuously for some time.'
type: object
properties:
count:
type: integer
format: int32
title: Number of occurrences in this series up to the last heartbeat time
lastObservedTime:
$ref: '#/definitions/v1MicroTime'
v1alpha1OrphanedResourceKey:
type: object
title: OrphanedResourceKey is a reference to a resource to be ignored from
properties:
group:
type: string
kind:
type: string
name:
type: string
v1alpha1SignatureKey:
description: 'Deprecated: Use SourceIntegrity instead. SignatureKeys will be removed with the next major version.'
type: object
title: SignatureKey is the specification of a key required to verify commit signatures with
properties:
keyID:
type: string
title: The ID of the key in hexadecimal notation
v1Event:
description: 'Event is a report of an event somewhere in the cluster. Events
have a limited retention time and triggers and messages may evolve
with time. Event consumers should not rely on the timing of an event
with a given Reason reflecting a consistent underlying trigger, or the
continued existence of events with that Reason. Events should be
treated as informative, best-effort, supplemental data.'
type: object
properties:
action:
type: string
title: 'What action was taken/failed regarding to the Regarding object.
+optional'
count:
type: integer
format: int32
title: 'The number of times this event has occurred.
+optional'
eventTime:
$ref: '#/definitions/v1MicroTime'
firstTimestamp:
$ref: '#/definitions/v1Time'
involvedObject:
$ref: '#/definitions/v1ObjectReference'
lastTimestamp:
$ref: '#/definitions/v1Time'
message:
type: string
title: 'A human-readable description of the status of this operation.
TODO: decide on maximum length.
+optional'
metadata:
$ref: '#/definitions/v1ObjectMeta'
reason:
type: string
title: 'This should be a short, machine understandable string that gives the reason
for the transition into the object''s current status.
TODO: provide exact specification for format.
+optional'
related:
$ref: '#/definitions/v1ObjectReference'
reportingComponent:
type: string
title: 'Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`.
+optional'
reportingInstance:
type: string
title: 'ID of the controller instance, e.g. `kubelet-xyzf`.
+optional'
series:
$ref: '#/definitions/v1EventSeries'
source:
$ref: '#/definitions/v1EventSource'
type:
type: string
title: 'Type of this event (Normal, Warning), new types could be added in the future
+optional'
v1alpha1JWTToken:
type: object
title: JWTToken holds the issuedAt and expiresAt values of a token
properties:
exp:
type: integer
format: int64
iat:
type: integer
format: int64
id:
type: string
v1alpha1AppProject:
type: object
title: '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'
properties:
metadata:
$ref: '#/definitions/v1ObjectMeta'
spec:
$ref: '#/definitions/v1alpha1AppProjectSpec'
status:
$ref: '#/definitions/v1alpha1AppProjectStatus'
v1ManagedFieldsEntry:
description: 'ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource
that the fieldset applies to.'
type: object
properties:
apiVersion:
description: 'APIVersion defines the version of this resource that this field set
applies to. The format is "group/version" just like the top-level
APIVersion field. It is necessary to track the version of a field
set because it cannot be automatically converted.'
type: string
fieldsType:
type: string
title: 'FieldsType is the discriminator for the different fields format and version.
There is currently only one possible value: "FieldsV1"'
fieldsV1:
$ref: '#/definitions/v1FieldsV1'
manager:
description: Manager is an identifier of the workflow managing these fields.
type: string
operation:
description: 'Operation is the type of operation which lead to this ManagedFieldsEntry being created.
The only valid values for this field are ''Apply'' and ''Update''.'
type: string
subresource:
description: 'Subresource is the name of the subresource used to update that object, or
empty string if the object was updated through the main resource. The
value of this field is used to distinguish between managers, even if they
share the same name. For example, a status update will be distinct from a
regular update using the same manager name.
Note that the APIVersion field is not related to the Subresource field and
it always corresponds to the version of the main resource.'
type: string
time:
$ref: '#/definitions/v1Time'
protobufAny:
type: object
properties:
type_url:
type: string
value:
type: string
format: byte
runtimeError:
type: object
properties:
code:
type: integer
format: int32
details:
type: array
items:
$ref: '#/definitions/protobufAny'
error:
type: string
message:
type: string
projectProjectTokenResponse:
description: ProjectTokenResponse wraps the created token or returns an empty string if deleted.
type: object
properties:
token:
type: string
projectProjectCreateRequest:
description: ProjectCreateRequest defines project creation parameters.
type: object
properties:
project:
$ref: '#/definitions/v1alpha1AppProject'
upsert:
type: boolean
v1alpha1ConnectionState:
type: object
title: ConnectionState contains information about remote resource connection state, currently used for clusters and repositories
properties:
attemptedAt:
$ref: '#/definitions/v1Time'
message:
type: string
title: Message contains human readable information about the connection status
status:
type: string
title: Status contains the current status indicator for the connection
v1alpha1ProjectRole:
type: object
title: ProjectRole represents a role that has access to a project
properties:
description:
type: string
title: Description is a description of the role
groups:
type: array
title: Groups are a list of OIDC group claims bound to this role
items:
type: string
jwtTokens:
type: array
title: JWTTokens are a list of generated JWT tokens bound to this role
items:
$ref: '#/definitions/v1alpha1JWTToken'
name:
type: string
title: Name is a name for this role
policies:
type: array
title: Policies Stores a list of casbin formatted strings that define access policies for the role in the project
items:
type: string
v1alpha1AppProjectList:
type: object
title: 'AppProjectList is list of AppProject resources
+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object'
properties:
items:
type: array
items:
$ref: '#/definitions/v1alpha1AppProject'
metadata:
$ref: '#/definitions/v1ListMeta'
v1alpha1OrphanedResourcesMonitorSettings:
type: object
title: OrphanedResourcesMonitorSettings holds settings of orphaned resources monitoring
properties:
ignore:
type: array
title: Ignore contains a list of resources that are to be excluded from orphaned resources monitoring
items:
$ref: '#/definitions/v1alpha1OrphanedResourceKey'
warn:
type: boolean
title: Warn indicates if warning condition should be created for apps which have orphaned resources
v1alpha1ApplicationDestination:
type: object
title: ApplicationDestination holds information about the application's destination
properties:
name:
description: Name is an alternate way of specifying the target cluster by its symbolic name. This must be set if Server is not set.
type: string
namespace:
type: string
title: 'Namespace specifies the target namespace for the application''s resources.
The namespace will only be set for namespace-scoped resources that have not set a value for .metadata.namespace'
server:
description: Server specifies the URL of the target cluster's Kubernetes control plane API. This must be set if Name is not set.
type: string
v1alpha1SourceIntegrityGitPolicyRepo:
type: object
properties:
url:
description: URL specifier, glob.
type: string
v1alpha1ExecProviderConfig:
type: object
title: 'ExecProviderConfig is config used to call an exte
# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/argocd/refs/heads/main/openapi/argocd-projectservice-api-openapi.yml