--- title: "List Promotions" method: GET path: "/v1beta1/projects/{project}/promotions" tags: ["Core", "Project-Level"] --- # List Promotions `GET /v1beta1/projects/{project}/promotions` List Promotion resources from a project's namespace. Returns a PromotionList resource. ## Path parameters - `project` string, required ## Query parameters - `stage` string ## Response `200` PromotionList custom resource - PromotionList - `apiVersion` string — APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional - `items` Promotion[] - `apiVersion` string — APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional - `kind` string — Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional - `metadata` V1ObjectMeta - `annotations` object — 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 - `creationTimestamp` string — CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional - `deletionGracePeriodSeconds` integer — 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` string — DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional - `finalizers` string[] — 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 - `generateName` string — 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 - `generation` integer — A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional - `labels` object — 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 - `managedFields` 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 - `apiVersion` string — 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. - `fieldsType` string — FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" - `fieldsV1` unknown - `manager` string — Manager is an identifier of the workflow managing these fields. - `operation` string — Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. - `subresource` string — 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. - `time` string — Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over. +optional - `name` 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names +optional - `namespace` string — 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 - `ownerReferences` V1OwnerReference[] — 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 - `apiVersion` string — API version of the referent. - `blockOwnerDeletion` boolean — If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional - `controller` boolean — If true, this reference points to the managing controller. +optional - `kind` string — Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - `name` string — Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names - `uid` string — UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids - `resourceVersion` string — 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 - `selfLink` string — Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional - `uid` string — 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 - `spec` PromotionSpec, required - `freight` string — Freight specifies the piece of Freight to be promoted into the Stage. Exactly one of Freight or Origin must be set. +kubebuilder:validation:Optional +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$` +akuity:test-kubebuilder-pattern=KubernetesName - `origin` FreightOrigin - `kind` string, required — Kind is the kind of resource from which Freight may have originated. At present, this can only be "Warehouse". +kubebuilder:validation:Required - `name` string, required — Name is the name of the resource of the kind indicated by the Kind field from which Freight may originate. +kubebuilder:validation:Required - `stage` string, required — Stage specifies the name of the Stage to which this Promotion applies. The Stage referenced by this field MUST be in the same namespace as the Promotion. +kubebuilder:validation:Required +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$` +akuity:test-kubebuilder-pattern=KubernetesName - `steps` PromotionStep[], required — Steps specifies the directives to be executed as part of this Promotion. The order in which the directives are executed is the order in which they are listed in this field. +kubebuilder:validation:Required +kubebuilder:validation:MinItems=1 +kubebuilder:validation:items:XValidation:message="Promotion step must have uses set and must not reference a task",rule="has(self.uses) && !has(self.task)" - `as` string — As is the alias this step can be referred to as. - `config` unknown - `continueOnError` boolean — ContinueOnError is a boolean value that, if set to true, will cause the Promotion to continue executing the next step even if this step fails. It also will not permit this failure to impact the overall status of the Promotion. - `if` string — If is an optional expression that, if present, must evaluate to a boolean value. If the expression evaluates to false, the step will be skipped. If the expression does not evaluate to a boolean value, the step will be considered to have failed. - `retry` PromotionStepRetry - `errorThreshold` integer — ErrorThreshold is the number of consecutive times the step must fail (for any reason) before retries are abandoned and the entire Promotion is marked as failed. If this field is set to 0, the effective default will be a step-specific one. If no step-specific default exists (i.e. is also 0), the effective default will be the system-wide default of 1. A value of 1 will cause the Promotion to be marked as failed after just a single failure; i.e. no retries will be attempted. There is no option to specify an infinite number of retries using a value such as -1. In a future release, Kargo is likely to become capable of distinguishing between recoverable and non-recoverable step failures. At that time, it is planned that unrecoverable failures will not be subject to this threshold and will immediately cause the Promotion to be marked as failed without further condition. - `timeout` string — Timeout is the soft maximum interval in which a step that returns a Running status (which typically indicates it's waiting for something to happen) may be retried. The maximum is a soft one because the check for whether the interval has elapsed occurs AFTER the step has run. This effectively means a step may run ONCE beyond the close of the interval. If this field is set to nil, the effective default will be a step-specific one. If no step-specific default exists (i.e. is also nil), the effective default will be the system-wide default of 0. A value of 0 will cause the step to be retried indefinitely unless the ErrorThreshold is reached. - `task` PromotionTaskReference - `kind` string — Kind is the type of the PromotionTask. Can be either PromotionTask or ClusterPromotionTask, default is PromotionTask. +kubebuilder:validation:Optional +kubebuilder:validation:Enum=PromotionTask;ClusterPromotionTask - `name` string, required — Name is the name of the (Cluster)PromotionTask. +kubebuilder:validation:Required +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$` +akuity:test-kubebuilder-pattern=KubernetesName - `uses` string — Uses identifies a runner that can execute this step. +kubebuilder:validation:Optional +kubebuilder:validation:MinLength=1 - `vars` ExpressionVariable[] — Vars is a list of variables that can be referenced by expressions in the step's Config. The values override the values specified in the PromotionSpec. - `name` string — Name is the name of the variable. +kubebuilder:validation:MinLength=1 +kubebuilder:validation:Pattern=^[a-zA-Z_]\w*$ - `value` string — Value is the value of the variable. It is allowed to utilize expressions in the value. See https://docs.kargo.io/user-guide/reference-docs/expressions for details. - `target` string — Target optionally names the Target, within the Promotion's own Project (namespace), that this Promotion promotes Freight to. Targets allow a single Stage to govern -- and promote Freight to -- multiple destinations. When set, the named Target must be one that the referenced Stage governs, i.e. one selected by the Stage's targetSelectors. When empty (the default), the Promotion promotes to the Stage itself. This preserves the behavior of Promotions created before Targets existed: classic Stages -- those without targetSelectors -- govern no Targets, so their Promotions leave this field empty. +kubebuilder:validation:Optional +kubebuilder:validation:MaxLength=253 +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$` +akuity:test-kubebuilder-pattern=KubernetesName - `vars` ExpressionVariable[] — Vars is a list of variables that can be referenced by expressions in promotion steps. - `name` string — Name is the name of the variable. +kubebuilder:validation:MinLength=1 +kubebuilder:validation:Pattern=^[a-zA-Z_]\w*$ - `value` string — Value is the value of the variable. It is allowed to utilize expressions in the value. See https://docs.kargo.io/user-guide/reference-docs/expressions for details. - `status` PromotionStatus - `currentStep` integer — CurrentStep is the index of the current promotion step being executed. This permits steps that have already run successfully to be skipped on subsequent reconciliations attempts. - `finishedAt` string — FinishedAt is the time when the promotion was completed. - `freight` FreightReference - `artifacts` ArtifactReference[] — Artifacts describes specific versions of artifacts other than Git repository commits, container images, and Helm charts. - `artifactType` string — ArtifactType specifies the type of artifact this is. Often, but not always, it will be the media type (MIME type) of the artifact referenced by this ArtifactReference. +kubebuilder:validation:MinLength=1 - `metadata` unknown - `subscriptionName` string — SubscriptionName is the name of the Subscription that discovered this artifact. +kubebuilder:validation:MinLength=1 - `version` string — Version identifies a specific revision of this artifact. +kubebuilder:validation:MinLength=1 - `charts` Chart[] — Charts describes specific versions of specific Helm charts. - `name` string — Name specifies the name of the chart. - `repoURL` string — RepoURL specifies the URL of a Helm chart repository. Classic chart repositories (using HTTP/S) can contain differently named charts. When this field points to such a repository, the Name field will specify the name of the chart within the repository. In the case of a repository within an OCI registry, the URL implicitly points to a specific chart and the Name field will be empty. - `subscriptionName` string — SubscriptionName is the name of the subscription that discovered this chart. This field is only populated if the subscription was assigned a name. - `version` string — Version specifies a particular version of the chart. - `commits` GitCommit[] — Commits describes specific Git repository commits. - `author` string — Author is the author of the commit. - `branch` string — Branch denotes the branch of the repository where this commit was found. - `committer` string — Committer is the person who committed the commit. - `id` string — ID is the ID of a specific commit in the Git repository specified by RepoURL. - `message` string — Message is the message associated with the commit. At present, this only contains the first line (subject) of the commit message. - `repoURL` string — RepoURL is the URL of a Git repository. - `subscriptionName` string — SubscriptionName is the name of the subscription that discovered this commit. This field is only populated if the subscription was assigned a name. - `tag` string — Tag denotes a tag in the repository that matched selection criteria and resolved to this commit. - `images` Image[] — Images describes specific versions of specific container images. - `annotations` object — Annotations is a map of arbitrary metadata for the image. - `digest` string — Digest identifies a specific version of the image in the repository specified by RepoURL. This is a more precise identifier than Tag. - `repoURL` string — RepoURL describes the repository in which the image can be found. - `subscriptionName` string — SubscriptionName is the name of the subscription that discovered this image. This field is only populated if the subscription was assigned a name. - `tag` string — Tag identifies a specific version of the image in the repository specified by RepoURL. - `name` string — Name is a system-assigned identifier derived deterministically from the contents of the Freight. I.e., two pieces of Freight can be compared for equality by comparing their Names. - `origin` FreightOrigin - `kind` string, required — Kind is the kind of resource from which Freight may have originated. At present, this can only be "Warehouse". +kubebuilder:validation:Required - `name` string, required — Name is the name of the resource of the kind indicated by the Kind field from which Freight may originate. +kubebuilder:validation:Required - `freightCollection` FreightCollection - `id` string — ID is a unique and deterministically calculated identifier for the FreightCollection. It is updated on each use of the UpdateOrPush method. - `items` object — Freight is a map of FreightReference objects, indexed by their Warehouse origin. - `verificationHistory` VerificationInfo[] — VerificationHistory is a stack of recent VerificationInfo. By default, the last ten VerificationInfo are stored. - `actor` string — Actor is the name of the entity that initiated or aborted the Verification process. - `analysisRun` AnalysisRunReference - `name` string — Name is the name of the AnalysisRun. - `namespace` string — Namespace is the namespace of the AnalysisRun. - `phase` string — Phase is the last observed phase of the AnalysisRun referenced by Name. - `finishTime` string — FinishTime is the time at which the Verification process finished. - `id` string — ID is the identifier of the Verification process. - `message` string — Message may contain additional information about why the verification process is in its current phase. - `phase` string — Phase describes the current phase of the Verification process. Generally, this will be a reflection of the underlying AnalysisRun's phase, however, there are exceptions to this, such as in the case where an AnalysisRun cannot be launched successfully. - `startTime` string — StartTime is the time at which the Verification process was started. - `healthChecks` HealthCheckStep[] — HealthChecks contains the health check directives to be executed after the Promotion has completed. - `config` unknown - `uses` string — Uses identifies a runner that can execute this step. +kubebuilder:validation:MinLength=1 - `lastHandledRefresh` string — LastHandledRefresh holds the value of the most recent AnnotationKeyRefresh annotation that was handled by the controller. This field can be used to determine whether the request to refresh the resource has been handled. +optional - `message` string — Message is a display message about the promotion, including any errors preventing the Promotion controller from executing this Promotion. i.e. If the Phase field has a value of Failed, this field can be expected to explain why. - `phase` string — Phase describes where the Promotion currently is in its lifecycle. - `startedAt` string — StartedAt is the time when the promotion started. - `state` unknown - `stepExecutionMetadata` StepExecutionMetadata[] — StepExecutionMetadata tracks metadata pertaining to the execution of individual promotion steps. - `alias` string — Alias is the alias of the step. - `continueOnError` boolean — ContinueOnError is a boolean value that, if set to true, will cause the Promotion to continue executing the next step even if this step fails. It also will not permit this failure to impact the overall status of the Promotion. - `errorCount` integer — ErrorCount tracks consecutive failed attempts to execute the step. - `finishedAt` string — FinishedAt is the time at which the final attempt to execute the step completed. - `message` string — Message is a display message about the step, including any errors. - `startedAt` string — StartedAt is the time at which the first attempt to execute the step began. - `status` string — Status is the high-level outcome of the step. - `kind` string — Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional - `metadata` V1ListMeta - `continue` string — continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. - `remainingItemCount` integer — remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. +optional - `resourceVersion` string — String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional - `selfLink` string — Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional - `shardInfo` V1ShardInfo - `selector` string — selector is the shard selector string from the request, echoed back so clients can verify which shard they received and merge responses from multiple shards. +required --- [API](https://skmtc.net/akuity/apis/kargo-api.md) · [All operations](https://skmtc.net/akuity/apis/kargo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/akuity/kargo-api/versions/132dee1064a1/schema)