Fetch scoped volume release metadata - Agent Volumes

GET

/

api

/

v1

/

volumes

/

@

{scope}

/

{name}

/

{version}

Fetch scoped volume release metadata

curl --request GET \
  --url https://api.example.com/api/v1/volumes/@{scope}/{name}/{version}

const options = {method: 'GET'};

fetch('https://api.example.com/api/v1/volumes/@{scope}/{name}/{version}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/volumes/@{scope}/{name}/{version}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/volumes/@{scope}/{name}/{version}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/volumes/@{scope}/{name}/{version}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "version": "<string>",
  "purl": "<string>",
  "integrity": "<string>",
  "status": {
    "state": "available",
    "reason": "<string>"
  },
  "externalDependencies": [
    {
      "declarationKey": "<string>",
      "purl": "<string>",
      "constraint": "<string>",
      "purpose": "runtime",
      "components": [
        "<string>"
      ]
    }
  ],
  "dist": {
    "source": "cdn",
    "mediaType": "application/gzip",
    "url": "<string>"
  }
}

Path Parameters

scope

string

required

Maximum string length: 64

Pattern: ^(?!.*--)[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$

name

string

required

Maximum string length: 128

Pattern: ^(?!.*--)[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$

version

string

required

Pattern:

^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*)(?:\.(?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*))*))?(?:\+([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?$

Response

Release metadata. Delivery metadata is subordinate to the release integrity value; clients reject resolved content whose normalized-file-tree digest does not match.

name

string

required

Maximum string length: 194

Pattern: ^(@(?!.*--)[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?/)?(?!.*--)[a-z0-9](?:[a-z0-9-]{0,126}[a-z0-9])?$

version

string

required

Pattern:

^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*)(?:\.(?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*))*))?(?:\+([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?$

purl

string

required

Pattern:

^pkg:volume/(?:%40(?![a-z0-9-]*--)[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?/)?(?![a-z0-9-]*--)[a-z0-9](?:[a-z0-9-]{0,126}[a-z0-9])?@(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*)(?:\.(?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*))*))?(?:\+([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?$

integrity

string

required

Pattern: ^sha256:[a-f0-9]{64}$

status

object

required

Show child attributes

externalDependencies

object[]

Declaration-only external package dependency metadata derived from the release manifest. These records are not resolved dependency inventory, lockfile content, provenance material, scanner findings, or vulnerability evidence.

Show child attributes

dist

object

Option 1
Option 2

Show child attributes

Fetch scoped volume release metadata

curl --request GET \
  --url https://api.example.com/api/v1/volumes/@{scope}/{name}/{version}

const options = {method: 'GET'};

fetch('https://api.example.com/api/v1/volumes/@{scope}/{name}/{version}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/volumes/@{scope}/{name}/{version}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/volumes/@{scope}/{name}/{version}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/volumes/@{scope}/{name}/{version}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "version": "<string>",
  "purl": "<string>",
  "integrity": "<string>",
  "status": {
    "state": "available",
    "reason": "<string>"
  },
  "externalDependencies": [
    {
      "declarationKey": "<string>",
      "purl": "<string>",
      "constraint": "<string>",
      "purpose": "runtime",
      "components": [
        "<string>"
      ]
    }
  ],
  "dist": {
    "source": "cdn",
    "mediaType": "application/gzip",
    "url": "<string>"
  }
}