API-referens
Alla HTTP-slutpunkter i modulen registry: autentisering, IAM-åtgärd, parametrar, innehåll och statuskoder.
Genererad från modulens kod när dess image byggdes — redigera inte. Sökvägarna är relativa till https://api.example.com.
Docs
GET /docs/registry/manifest.json
- Autentisering: krävs
- Operationsnamn:
DocsManifest_registry
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
GET /docs/registry/{path}
- Autentisering: krävs
- Operationsnamn:
DocsFile_registry
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
path |
sökväg | string |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
Registry Admin
POST /v1/internal/registries/mint-boundary-credential
- Autentisering: krävs
- Operationsnamn:
MintBoundaryCredential
Begärans innehåll: MintBoundaryRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
POST /v1/internal/registries/mint-build-token
- Autentisering: krävs
- Operationsnamn:
MintBuildToken
Begärans innehåll: MintBuildRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
Registry Audit
GET /resources/registries/audit
- Autentisering: krävs
- IAM-åtgärd:
registry/audit/read— utvärderas på plattformens rot - Operationsnamn:
ListRegistryAuditEvents
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
action |
frågesträng | string |
Nej |
boundary |
frågesträng | string |
Nej |
correlation_id |
frågesträng | uuid |
Nej |
from |
frågesträng | date-time |
Nej |
limit |
frågesträng | integer |
Nej |
repository |
frågesträng | string |
Nej |
to |
frågesträng | date-time |
Nej |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte registry/audit/read på det utvärderade omfånget |
Registry Manifests
GET /v1/internal/registries/manifests
- Autentisering: krävs
- Operationsnamn:
GetManifest
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
repository |
frågesträng | string |
Nej |
tag |
frågesträng | string |
Nej |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
Registry Pins
DELETE /v1/internal/registries/pins
- Autentisering: krävs
- Operationsnamn:
DeletePins
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundary |
frågesträng | string |
Nej |
repository |
frågesträng | string |
Nej |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
PUT /v1/internal/registries/pins
- Autentisering: krävs
- Operationsnamn:
PutPins
Begärans innehåll: PinUpsertRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
Registry Retention
GET /v1/registries/retention/preview
- Autentisering: krävs
- IAM-åtgärd:
registry/audit/read— utvärderas på plattformens rot - Operationsnamn:
PreviewRetentionSweep
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
boundary |
frågesträng | string |
Nej |
repository |
frågesträng | string |
Nej |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte registry/audit/read på det utvärderade omfånget |
GET /v1/registries/retention/runs
- Autentisering: krävs
- IAM-åtgärd:
registry/audit/read— utvärderas på plattformens rot - Operationsnamn:
ListRetentionRuns
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
limit |
frågesträng | integer |
Nej |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte registry/audit/read på det utvärderade omfånget |
POST /v1/registries/retention/runs
- Autentisering: krävs
- IAM-åtgärd:
registry/retention/manage— utvärderas på plattformens rot - Operationsnamn:
TriggerRetentionRun
Begärans innehåll: PostRunRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte registry/retention/manage på det utvärderade omfånget |
Övriga slutpunkter
GET /readyz
- Autentisering: ingen — anonyma anrop accepteras
- Operationsnamn:
StackshipReadiness
Svar
| Status | Betydelse | Innehåll |
|---|
GET /registry/auth/token
- Autentisering: ingen — anonyma anrop accepteras
- Operationsnamn:
RegistryAuthTokenGet
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK |
POST /registry/auth/token
- Autentisering: ingen — anonyma anrop accepteras
- Operationsnamn:
RegistryAuthToken
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK |
POST /v1/internal/registries/notify
- Autentisering: ingen — anonyma anrop accepteras
- Operationsnamn:
RegistryNotify
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK |
Scheman
MintBoundaryRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
boundary |
string |
Nej |
MintBuildRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
boundary |
string |
Nej |
kind |
string |
Nej |
name |
string |
Nej |
resourceGroup |
string |
Nej |
PinUpsertRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
boundary |
string |
Nej |
digests |
string [] |
Nej |
expiresAt |
date-time |
Nej |
keepForDays |
integer |
Ja |
keepLast |
integer |
Ja |
repository |
string |
Nej |
PostRunRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
dryRun |
boolean |
Ja |