OCI

List Tags

List multiple OCITags

An OCIRepository can publish zero or more OCITags. OCITags are names that point to a unique OCIArtifact digest.

An OCITag’s ID is comprised of the OCIRepository ID followed by a : and the Tag name.

Examples of OCITag identifiers:

docker.io/istio/pilot:1.3.0: The 1.3.0 tag on the docker.io/istio/pilot OCIRepository.
public.ecr.aws/bottlerocket/bottlerocket-operator:0.1: The 0.1 tag on the public.ecr.aws/bottlerocket/bottlerocket-operator OCIRepository.

GET

ocitags

List Tags

curl --request GET \
  --url https://api.example.com/ocitags

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/ocitags",
  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/ocitags"

	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/ocitags")

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

{
  "results": [
    {
      "artifact": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad",
      "created_by": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "last_modified_by": "<string>",
      "last_modified_on": "2023-11-07T05:31:56Z",
      "repository": "<string>",
      "tag": "1.0.2",
      "$schema": "https://example.com/schemas/OCITag.json"
    }
  ],
  "$schema": "https://example.com/schemas/ListOCITagsOutputBody.json",
  "pagination": {
    "continue": "<string>"
  }
}

{
  "$schema": "https://example.com/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Query Parameters

continue

string

Continuation token value (used when retrieving the next page of results).

integer<int64>

Number of records to show per page of results.

Required range: 0 <= x <= 100

filter

string

Record filter.

Response

results

object[] | null

required

Show child attributes

$schema

string<uri>

read-only

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/ListOCITagsOutputBody.json"

pagination

object

Show child attributes

⌘I

List Tags

curl --request GET \
  --url https://api.example.com/ocitags

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/ocitags",
  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/ocitags"

	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/ocitags")

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

{
  "results": [
    {
      "artifact": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad",
      "created_by": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "last_modified_by": "<string>",
      "last_modified_on": "2023-11-07T05:31:56Z",
      "repository": "<string>",
      "tag": "1.0.2",
      "$schema": "https://example.com/schemas/OCITag.json"
    }
  ],
  "$schema": "https://example.com/schemas/ListOCITagsOutputBody.json",
  "pagination": {
    "continue": "<string>"
  }
}

{
  "$schema": "https://example.com/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

API Reference

Login

Risk

Account

KubeCluster

KubePlatform

OCI

Organization

Package

Project

List Tags

Query Parameters

Response