Models

projectGlobalProjectsResponse

object

itemsArray<v1alpha1AppProject>

Show child attributes

metadatav1ObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Show child attributes

annotationsobject

Show child attributes

[key: string]string

creationTimestampv1Time<date-time>

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

deletionGracePeriodSecondsinteger<int64>

deletionTimestampv1Time<date-time>

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

finalizersArray<string>

generateNamestring

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

generationinteger<int64>

labelsobject

Show child attributes

[key: string]string

managedFieldsArray<v1ManagedFieldsEntry>

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 +k8s:alpha(since: "1.37")=+k8s:optional

Show child attributes

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

apiVersionstring

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.

fieldsTypestring

fieldsV1v1FieldsV1

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:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where 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 +k8s:deepcopy-gen=false +protobuf.options.marshal=false +protobuf.options.(gogoproto.goproto_stringer)=false

Show child attributes

Rawstring<byte>

Raw is the underlying serialization of this object.

Deprecated: Direct access to this field is deprecated. Use GetRawBytes, GetRawString, SetRawBytes, SetRawString, GetRawReader, NewFieldsV1 instead.

managerstring

Manager is an identifier of the workflow managing these fields.

operationstring

subresourcestring

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.

timev1Time<date-time>

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

namestring

namespacestring

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

ownerReferencesArray<v1OwnerReference>

Show child attributes

apiVersionstring

blockOwnerDeletionboolean

controllerboolean

kindstring

namestring

uidstring

resourceVersionstring

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

selfLinkstring

uidstring

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 +k8s:alpha(since: "1.37")=+k8s:optional +k8s:alpha(since: "1.37")=+k8s:immutable

specv1alpha1AppProjectSpec

Show child attributes

clusterResourceBlacklistArray<v1alpha1ClusterResourceRestrictionItem>

Show child attributes

groupstring

kindstring

namestring

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.

clusterResourceWhitelistArray<v1alpha1ClusterResourceRestrictionItem>

Show child attributes

groupstring

kindstring

namestring

descriptionstring

destinationServiceAccountsArray<v1alpha1ApplicationDestinationServiceAccount>

DestinationServiceAccounts holds information about the service accounts to be impersonated for the application sync operation for each destination.

Show child attributes

ApplicationDestinationServiceAccount holds information about the service account to be impersonated for the application sync operation.

defaultServiceAccountstring

namespacestring

Namespace specifies the target namespace for the application's resources.

serverstring

Server specifies the URL of the target cluster's Kubernetes control plane API.

destinationsArray<v1alpha1ApplicationDestination>

Show child attributes

namestring

Name is an alternate way of specifying the target cluster by its symbolic name. This must be set if Server is not set.

namespacestring

serverstring

Server specifies the URL of the target cluster's Kubernetes control plane API. This must be set if Name is not set.

namespaceResourceBlacklistArray<v1GroupKind>

Show child attributes

+protobuf.options.(gogoproto.goproto_stringer)=false

groupstring

kindstring

namespaceResourceWhitelistArray<v1GroupKind>

Show child attributes

+protobuf.options.(gogoproto.goproto_stringer)=false

groupstring

kindstring

orphanedResourcesv1alpha1OrphanedResourcesMonitorSettings

Show child attributes

ignoreArray<v1alpha1OrphanedResourceKey>

Show child attributes

groupstring

kindstring

namestring

warnboolean

permitOnlyProjectScopedClustersboolean

rolesArray<v1alpha1ProjectRole>

Show child attributes

descriptionstring

groupsArray<string>

jwtTokensArray<v1alpha1JWTToken>

Show child attributes

expinteger<int64>

iatinteger<int64>

idstring

namestring

policiesArray<string>

signatureKeysArray<v1alpha1SignatureKey>

Deprecated: Use SourceIntegrity instead. SignatureKeys will be removed with the next major version.

Show child attributes

Deprecated: Use SourceIntegrity instead. SignatureKeys will be removed with the next major version.

keyIDstring

sourceIntegrityv1alpha1SourceIntegrity

Show child attributes

gitv1alpha1SourceIntegrityGit

Show child attributes

policiesArray<v1alpha1SourceIntegrityGitPolicy>

Show child attributes

gpgv1alpha1SourceIntegrityGitPolicyGPG

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.

Show child attributes

keysArray<string>

List of key IDs to trust. The keys need to be in the repository server keyring.

modestring

reposArray<v1alpha1SourceIntegrityGitPolicyRepo>

Show child attributes

urlstring

URL specifier, glob.

sourceNamespacesArray<string>

sourceReposArray<string>

syncWindowsArray<v1alpha1InlineSyncWindow>

Show child attributes

andOperatorboolean

applicationsArray<string>

clustersArray<string>

descriptionstring

durationstring

kindstring

manualSyncboolean

namespacesArray<string>

schedulestring

syncOverrunboolean

timeZonestring

statusv1alpha1AppProjectStatus

Show child attributes

jwtTokensByRoleobject

Show child attributes

[key: string]v1alpha1JWTTokens

Show child attributes

itemsArray<v1alpha1JWTToken>

Show child attributes

expinteger<int64>

iatinteger<int64>

idstring

Example

{
  "items": [
    {
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2024-01-15T09:30:00Z",
        "deletionGracePeriodSeconds": 0,
        "deletionTimestamp": "2024-01-15T09:30:00Z",
        "finalizers": [
          "string"
        ],
        "generateName": "string",
        "generation": 0,
        "labels": {},
        "managedFields": [
          {
            "apiVersion": "string",
            "fieldsType": "string",
            "fieldsV1": {
              "Raw": "dGVzdA=="
            },
            "manager": "string",
            "operation": "string",
            "subresource": "string",
            "time": "2024-01-15T09:30:00Z"
          }
        ],
        "name": "string",
        "namespace": "string",
        "ownerReferences": [
          {
            "apiVersion": "string",
            "blockOwnerDeletion": true,
            "controller": true,
            "kind": "string",
            "name": "string",
            "uid": "string"
          }
        ],
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "spec": {
        "clusterResourceBlacklist": [
          {
            "group": "string",
            "kind": "string",
            "name": "string"
          }
        ],
        "clusterResourceWhitelist": [
          {
            "group": "string",
            "kind": "string",
            "name": "string"
          }
        ],
        "description": "string",
        "destinationServiceAccounts": [
          {
            "defaultServiceAccount": "string",
            "namespace": "string",
            "server": "string"
          }
        ],
        "destinations": [
          {
            "name": "string",
            "namespace": "string",
            "server": "string"
          }
        ],
        "namespaceResourceBlacklist": [
          {
            "group": "string",
            "kind": "string"
          }
        ],
        "namespaceResourceWhitelist": [
          {
            "group": "string",
            "kind": "string"
          }
        ],
        "orphanedResources": {
          "ignore": [
            {
              "group": "string",
              "kind": "string",
              "name": "string"
            }
          ],
          "warn": true
        },
        "permitOnlyProjectScopedClusters": true,
        "roles": [
          {
            "description": "string",
            "groups": [
              "string"
            ],
            "jwtTokens": [
              {
                "exp": 0,
                "iat": 0,
                "id": "string"
              }
            ],
            "name": "string",
            "policies": [
              "string"
            ]
          }
        ],
        "signatureKeys": [
          {
            "keyID": "string"
          }
        ],
        "sourceIntegrity": {
          "git": {
            "policies": [
              {
                "gpg": {
                  "keys": [
                    "string"
                  ],
                  "mode": "string"
                },
                "repos": [
                  {
                    "url": "string"
                  }
                ]
              }
            ]
          }
        },
        "sourceNamespaces": [
          "string"
        ],
        "sourceRepos": [
          "string"
        ],
        "syncWindows": [
          {
            "andOperator": true,
            "applications": [
              "string"
            ],
            "clusters": [
              "string"
            ],
            "description": "string",
            "duration": "string",
            "kind": "string",
            "manualSync": true,
            "namespaces": [
              "string"
            ],
            "schedule": "string",
            "syncOverrun": true,
            "timeZone": "string"
          }
        ]
      },
      "status": {
        "jwtTokensByRole": {}
      }
    }
  ]
}

Docs by Sourcey