Argo CD ProjectService API
The ProjectService API from Argo CD — 10 operation(s) for projectservice.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/argocd-projectservice-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: Description of all APIs
title: Consolidate Services AccountService Project Service API
version: version not set
tags:
- name: ProjectService
paths:
/api/v1/projects:
get:
tags:
- ProjectService
summary: List returns list of projects
operationId: ProjectService_List
parameters:
- name: name
in: query
schema:
type: string
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/v1alpha1AppProjectList'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
post:
tags:
- ProjectService
summary: Create a new project
operationId: ProjectService_Create
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/v1alpha1AppProject'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/projectProjectCreateRequest'
required: true
/api/v1/projects/{name}:
get:
tags:
- ProjectService
summary: Get returns a project by name
operationId: ProjectService_Get
parameters:
- name: name
in: path
required: true
schema:
type: string
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/v1alpha1AppProject'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
delete:
tags:
- ProjectService
summary: Delete deletes a project
operationId: ProjectService_Delete
parameters:
- name: name
in: path
required: true
schema:
type: string
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/projectEmptyResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/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:
- name: name
in: path
required: true
schema:
type: string
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/projectDetailedProjectsResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
/api/v1/projects/{name}/events:
get:
tags:
- ProjectService
summary: ListEvents returns a list of project events
operationId: ProjectService_ListEvents
parameters:
- name: name
in: path
required: true
schema:
type: string
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/v1EventList'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
/api/v1/projects/{name}/globalprojects:
get:
tags:
- ProjectService
summary: Get returns a virtual project by name
operationId: ProjectService_GetGlobalProjects
parameters:
- name: name
in: path
required: true
schema:
type: string
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/projectGlobalProjectsResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
/api/v1/projects/{name}/links:
get:
tags:
- ProjectService
summary: ListLinks returns all deep links for the particular project
operationId: ProjectService_ListLinks
parameters:
- name: name
in: path
required: true
schema:
type: string
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/applicationLinksResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
/api/v1/projects/{name}/syncwindows:
get:
tags:
- ProjectService
summary: GetSchedulesState returns true if there are any active sync syncWindows
operationId: ProjectService_GetSyncWindowsState
parameters:
- name: name
in: path
required: true
schema:
type: string
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/projectSyncWindowsResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
/api/v1/projects/{project.metadata.name}:
put:
tags:
- ProjectService
summary: Update updates a project
operationId: ProjectService_Update
parameters:
- 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
schema:
type: string
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/v1alpha1AppProject'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/projectProjectUpdateRequest'
required: true
/api/v1/projects/{project}/roles/{role}/token:
post:
tags:
- ProjectService
summary: Create a new project token
operationId: ProjectService_CreateToken
parameters:
- name: project
in: path
required: true
schema:
type: string
- name: role
in: path
required: true
schema:
type: string
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/projectProjectTokenResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/projectProjectTokenCreateRequest'
required: true
/api/v1/projects/{project}/roles/{role}/token/{iat}:
delete:
tags:
- ProjectService
summary: Delete a new project token
operationId: ProjectService_DeleteToken
parameters:
- name: project
in: path
required: true
schema:
type: string
- name: role
in: path
required: true
schema:
type: string
- name: iat
in: path
required: true
schema:
type: string
format: int64
- name: id
in: query
schema:
type: string
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/projectEmptyResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
components:
schemas:
projectEmptyResponse:
type: object
v1alpha1SourceIntegrityGitPolicy:
type: object
properties:
gpg:
$ref: '#/components/schemas/v1alpha1SourceIntegrityGitPolicyGPG'
repos:
type: array
title: List of repository criteria restricting repositories the policy will apply to
items:
$ref: '#/components/schemas/v1alpha1SourceIntegrityGitPolicyRepo'
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: '#/components/schemas/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: '#/components/schemas/v1Time'
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
v1alpha1AWSAuthConfig:
type: object
title: AWSAuthConfig is an AWS IAM authentication configuration
properties:
clusterName:
type: string
title: ClusterName contains AWS cluster name
profile:
description: Profile contains optional role ARN. If set then AWS IAM Authenticator uses the profile to perform cluster operations instead of the default AWS credential provider chain.
type: string
roleARN:
description: RoleARN contains optional role ARN. If set then AWS IAM Authenticator assume a role to perform cluster operations instead of the default AWS credential provider chain.
type: string
v1ObjectMeta:
description: 'ObjectMeta is metadata that all persisted resources must have, which includes all objects
users must create.'
type: object
properties:
annotations:
type: object
title: 'Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
+optional'
additionalProperties:
type: string
creationTimestamp:
$ref: '#/components/schemas/v1Time'
deletionGracePeriodSeconds:
type: integer
format: int64
title: 'Number of seconds allowed for this object to gracefully terminate before
it will be removed from the system. Only set when deletionTimestamp is also set.
May only be shortened.
Read-only.
+optional'
deletionTimestamp:
$ref: '#/components/schemas/v1Time'
finalizers:
type: array
title: 'Must be empty before the object is deleted from the registry. Each entry
is an identifier for the responsible component that will remove the entry
from the list. If the deletionTimestamp of the object is non-nil, entries
in this list can only be removed.
Finalizers may be processed and removed in any order. Order is NOT enforced
because it introduces significant risk of stuck finalizers.
finalizers is a shared field, any actor with permission can reorder it.
If the finalizer list is processed in order, then this can lead to a situation
in which the component responsible for the first finalizer in the list is
waiting for a signal (field value, external system, or other) produced by a
component responsible for a finalizer later in the list, resulting in a deadlock.
Without enforced ordering finalizers are free to order amongst themselves and
are not vulnerable to ordering changes in the list.
+optional
+patchStrategy=merge
+listType=set'
items:
type: string
generateName:
description: 'GenerateName is an optional prefix, used by the server, to generate a unique
name ONLY IF the Name field has not been provided.
If this field is used, the name returned to the client will be different
than the name passed. This value will also be combined with a unique suffix.
The provided value has the same validation rules as the Name field,
and may be truncated by the length of the suffix required to make the value
unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
+optional'
type: string
generation:
type: integer
format: int64
title: 'A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
+optional'
labels:
type: object
title: 'Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
+optional'
additionalProperties:
type: string
managedFields:
description: 'ManagedFields maps workflow-id and version to the set of fields
that are managed by that workflow. This is mostly for internal
housekeeping, and users typically shouldn''t need to set or
understand this field. A workflow can be the user''s name, a
controller''s name, or the name of a specific apply path like
"ci-cd". The set of fields is always in the version that the
workflow used when modifying the object.
+optional
+listType=atomic'
type: array
items:
$ref: '#/components/schemas/v1ManagedFieldsEntry'
name:
type: string
title: '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'
namespace:
description: 'Namespace defines the space within which each name must be unique. An empty namespace is
equivalent to the "default" namespace, but "default" is the canonical representation.
Not all objects are required to be scoped to a namespace - the value of this field for
those objects will be empty.
Must be a DNS_LABEL.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
+optional'
type: string
ownerReferences:
type: array
title: 'List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller,
then an entry in this list will point to this controller, with the controller field set to true.
There cannot be more than one managing controller.
+optional
+patchMergeKey=uid
+patchStrategy=merge
+listType=map
+listMapKey=uid'
items:
$ref: '#/components/schemas/v1OwnerReference'
resourceVersion:
description: 'An opaque value that represents the internal version of this object that can
be used by clients to determine when objects have changed. May be used for optimistic
concurrency, change detection, and the watch operation on a resource or set of resources.
Clients must treat these values as opaque and passed unmodified back to the server.
They may only be valid for a particular resource or set of resources.
Populated by the system.
Read-only.
Value must be treated as opaque by clients and .
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+optional'
type: string
selfLink:
type: string
title: 'Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
+optional'
uid:
description: 'UID is the unique in time and space value for this object. It is typically generated by
the server on successful creation of a resource and is not allowed to change on PUT
operations.
Populated by the system.
Read-only.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
+optional'
type: string
runtimeError:
type: object
properties:
code:
type: integer
format: int32
details:
type: array
items:
$ref: '#/components/schemas/protobufAny'
error:
type: string
message:
type: string
v1alpha1ClusterCacheInfo:
type: object
title: ClusterCacheInfo contains information about the cluster cache
properties:
apisCount:
type: integer
format: int64
title: APIsCount holds number of observed Kubernetes API count
lastCacheSyncTime:
$ref: '#/components/schemas/v1Time'
resourcesCount:
type: integer
format: int64
title: ResourcesCount holds number of observed Kubernetes resources
applicationLinksResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/applicationLinkInfo'
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: '#/components/schemas/v1ObjectMeta'
spec:
$ref: '#/components/schemas/v1alpha1AppProjectSpec'
status:
$ref: '#/components/schemas/v1alpha1AppProjectStatus'
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: '#/components/schemas/v1MicroTime'
v1alpha1ExecProviderConfig:
type: object
title: 'ExecProviderConfig is config used to call an external command to perform cluster authentication
See: https://godoc.org/k8s.io/client-go/tools/clientcmd/api#ExecConfig'
properties:
apiVersion:
type: string
title: Preferred input version of the ExecInfo
args:
type: array
title: Arguments to pass to the command when executing it
items:
type: string
command:
type: string
title: Command to execute
env:
type: object
title: Env defines additional environment variables to expose to the process
additionalProperties:
type: string
installHint:
type: string
title: This text is shown to the user when the executable doesn't seem to be present
v1alpha1ClusterResourceRestrictionItem:
type: object
title: ClusterResourceRestrictionItem is a cluster resource that is restricted by the project's whitelist or blacklist
properties:
group:
type: string
kind:
type: string
name:
description: 'Name is the name of the restricted resource. Glob patterns using Go''s filepath.Match syntax are supported.
Unlike the group and kind fields, if no name is specified, all resources of the specified group/kind are matched.'
type: string
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
projectProjectTokenResponse:
description: ProjectTokenResponse wraps the created token or returns an empty string if deleted.
type: object
properties:
token:
type: string
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: '#/components/schemas/v1alpha1OrphanedResourceKey'
warn:
type: boolean
title: Warn indicates if warning condition should be created for apps which have orphaned resources
projectDetailedProjectsResponse:
type: object
properties:
clusters:
type: array
items:
$ref: '#/components/schemas/v1alpha1Cluster'
globalProjects:
type: array
items:
$ref: '#/components/schemas/v1alpha1AppProject'
project:
$ref: '#/components/schemas/v1alpha1AppProject'
repositories:
type: array
items:
$ref: '#/components/schemas/v1alpha1Repository'
v1alpha1ClusterInfo:
type: object
title: ClusterInfo contains information about the cluster
properties:
apiVersions:
type: array
title: APIVersions contains list of API versions supported by the cluster
items:
type: string
applicationsCount:
type: integer
format: int64
title: ApplicationsCount is the number of applications managed by Argo CD on the cluster
cacheInfo:
$ref: '#/components/schemas/v1alpha1ClusterCacheInfo'
connectionState:
$ref: '#/components/schemas/v1alpha1ConnectionState'
serverVersion:
type: string
title: ServerVersion contains information about the Kubernetes version of the cluster
v1alpha1JWTTokens:
type: object
title: JWTTokens represents a list of JWT tokens
properties:
items:
type: array
items:
$ref: '#/components/schemas/v1alpha1JWTToken'
v1EventSource:
description: EventSource contains information for an event.
type: object
properties:
component:
type: string
title: 'Component from which the event is generated.
+optional'
host:
type: string
title: 'Node name on which the event is generated.
+optional'
v1EventList:
description: EventList is a list of events.
type: object
properties:
items:
type: array
title: List of events
items:
$ref: '#/components/schemas/v1Event'
metadata:
$ref: '#/components/schemas/v1ListMeta'
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: '#/components/schemas/v1alpha1ClusterResourceRestrictionItem'
clusterResourceWhitelist:
type: array
title: ClusterResourceWhitelist contains list of whitelisted cluster level resources
items:
$ref: '#/components/schemas/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: '#/components/schemas/v1alpha1ApplicationDestinationServiceAccount'
destinations:
type: array
title: Destinations contains list of destinations available for deployment
items:
$ref: '#/components/schemas/v1alpha1ApplicationDestination'
namespaceResourceBlacklist:
type: array
title: NamespaceResourceBlacklist contains list of blacklisted namespace level resources
items:
$ref: '#/components/schemas/v1GroupKind'
namespaceResourceWhitelist:
type: array
title: NamespaceResourceWhitelist contains list of whitelisted namespace level resources
items:
$ref: '#/components/schemas/v1GroupKind'
orphanedResources:
$ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/v1alpha1SignatureKey'
sourceIntegrity:
$ref: '#/components/schemas/v1alpha1SourceIntegrity'
sourceNamespaces:
type: array
title: SourceNamespaces defines the namespaces application resources are allowed to be created in
items:
type: string
# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/argocd/refs/heads/main/openapi/argocd-projectservice-api-openapi.yml