ApplicationService

Get the meta-data (author, date, tags, message) for a specific revision of the application

GET

https://argocd.example.com/api/v1/applications/{name}/revisions/{revision}/metadata

curl -X GET 'https://argocd.example.com/api/v1/applications/string/revisions/string/metadata' \
  -H 'Authorization: YOUR_TOKEN'

const response = await fetch('https://argocd.example.com/api/v1/applications/string/revisions/string/metadata', {
  method: 'GET',
  headers: {
    'Authorization': 'YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://argocd.example.com/api/v1/applications/string/revisions/string/metadata',
    headers={
        'Authorization': 'YOUR_TOKEN',
    },
)
print(response.text)

{
  "author": "string",
  "date": "2024-01-15T09:30:00Z",
  "message": "string",
  "references": [
    {
      "commit": {
        "author": "string",
        "body": "string",
        "date": "string",
        "repoUrl": "string",
        "sha": "string",
        "subject": "string"
      }
    }
  ],
  "signatureInfo": "string",
  "sourceIntegrityResult": {
    "checks": [
      {
        "name": "string",
        "problems": [
          "string"
        ]
      }
    ]
  },
  "tags": [
    "string"
  ]
}

{
  "code": 0,
  "details": [
    {
      "type_url": "string",
      "value": "dGVzdA=="
    }
  ],
  "error": "string",
  "message": "string"
}

Parameters

namestringrequiredpath

the application's name

revisionstringrequiredpath

the revision of the app

appNamespacestringquery

the application's namespace.

projectstringquery

sourceIndexinteger<int32>query

source index (for multi source apps).

versionIdinteger<int32>query

versionId from historical data (for multi source apps).

Response

200OKv1alpha1RevisionMetadata

A successful response.

Response fields application/json

RevisionMetadata contains metadata for a specific revision in a Git repository. This field is used by the Source Hydrator feature which may be removed in the future.

authorstring

datev1Time<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

messagestring

Message contains the message associated with the revision, most likely the commit message.

referencesArray<v1alpha1RevisionReference>

References contains references to information that's related to this commit in some way.

Show child attributes

RevisionReference contains a reference to a some information that is related in some way to another commit. For now, it supports only references to a commit. In the future, it may support other types of references.

commitv1alpha1CommitMetadata

CommitMetadata contains metadata about a commit that is related in some way to another commit.

Show child attributes

authorstring

Author is the author of the commit, i.e. git show -s --format=%an <%ae>. Must be formatted according to RFC 5322 (mail.Address.String()). Comes from the Argocd-reference-commit-author trailer.

bodystring

Body is the commit message body minus the subject line, i.e. git show -s --format=%b. Comes from the Argocd-reference-commit-body trailer.

datestring

Date is the date of the commit, formatted as by git show -s --format=%aI (RFC 3339). It can also be an empty string if the date is unknown. Comes from the Argocd-reference-commit-date trailer.

repoUrlstring

RepoURL is the URL of the repository where the commit is located. Comes from the Argocd-reference-commit-repourl trailer. This value is not validated and should not be used to construct UI links unless it is properly validated and/or sanitized first.

shastring

SHA is the commit hash. Comes from the Argocd-reference-commit-sha trailer.

subjectstring

Subject is the commit message subject line, i.e. git show -s --format=%s. Comes from the Argocd-reference-commit-subject trailer.

signatureInfostring

SignatureInfo contains a hint on the signer if the revision was signed with GPG, and signature verification is enabled.

Deprecated: Use SourceIntegrityResult for more detailed information. SignatureInfo will be removed with the next major version.

sourceIntegrityResultv1alpha1SourceIntegrityCheckResult

SourceIntegrityCheckResult represents a conclusion of the SourceIntegrity evaluation. Each check performed on a source(es), holds a check item representing all checks performed.

Show child attributes

checksArray<v1alpha1SourceIntegrityCheckResultItem>

Checks holds a list of checks performed, with their eventual problems. If a check is not specified here, it means it was not performed.

Show child attributes

namestring

Name of the check that is human-understandable pointing out to the kind of verification performed.

problemsArray<string>

Problems is a list of messages explaining why the check failed. Empty list means the check has succeeded.

tagsArray<string>

defaultruntimeError

An unexpected error response.

Response fields application/json