Hoppa till innehållet
Stackship-dokumentation English

HemligheterAnvändareMaskinöversatt

API-referens

Alla HTTP-slutpunkter i modulen secrets: 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/secrets/manifest.json

  • Autentisering: krävs
  • Operationsnamn: DocsManifest_secrets

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token

GET /docs/secrets/{path}

  • Autentisering: krävs
  • Operationsnamn: DocsFile_secrets

Parametrar

Namn Plats Typ Obligatorisk
path sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token

Secret Vaults

GET /boundaries/{boundaryId}/resources/secretvaults/accessible

List secret vaults accessible by a given principal

  • Autentisering: krävs
  • IAM-åtgärd: secretvault/read — utvärderas på resursen i sökvägen
  • Operationsnamn: GetAccessibleVaults

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte secretvault/read på det utvärderade omfånget

SecretVault

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/secretvaults

List all secretvaults in a resource group

  • Autentisering: krävs
  • IAM-åtgärd: secretvault/read — utvärderas på resursen i sökvägen
  • Operationsnamn: ListSecretVaults

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroupName sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte secretvault/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/secretvaults/config

Get list configuration for secretvaults

  • Autentisering: krävs
  • IAM-åtgärd: secretvault/read — utvärderas på resursen i sökvägen
  • Operationsnamn: GetSecretVaultsConfig

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg string Ja
resourceGroupName sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte secretvault/read på det utvärderade omfånget

DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/secretvaults/{resourceName}

Delete a secretvault

  • Autentisering: krävs
  • IAM-åtgärd: secretvault/delete — utvärderas på resursen i sökvägen
  • Operationsnamn: DeleteSecretVault

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroupName sökväg string Ja
resourceName sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte secretvault/delete på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/secretvaults/{resourceName}

Get a specific secretvault

  • Autentisering: krävs
  • IAM-åtgärd: secretvault/read — utvärderas på resursen i sökvägen
  • Operationsnamn: GetSecretVault

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroupName sökväg string Ja
resourceName sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte secretvault/read på det utvärderade omfånget

PATCH /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/secretvaults/{resourceName}

Partially update an existing secretvault using JSON Merge Patch

  • Autentisering: krävs
  • IAM-åtgärd: secretvault/write — utvärderas på resursen i sökvägen
  • Operationsnamn: PatchSecretVault

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroupName sökväg string Ja
resourceName sökväg string Ja

Begärans innehåll: any

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte secretvault/write på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/secretvaults/{resourceName}

Create a new secretvault

  • Autentisering: krävs
  • IAM-åtgärd: secretvault/write — utvärderas på resursen i sökvägen
  • Operationsnamn: CreateSecretVault

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroupName sökväg string Ja
resourceName sökväg string Ja

Begärans innehåll: SecretVaultDto

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte secretvault/write på det utvärderade omfånget

PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/secretvaults/{resourceName}

Update an existing secretvault

  • Autentisering: krävs
  • IAM-åtgärd: secretvault/write — utvärderas på resursen i sökvägen
  • Operationsnamn: UpdateSecretVault

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroupName sökväg string Ja
resourceName sökväg string Ja

Begärans innehåll: SecretVaultDto

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte secretvault/write på det utvärderade omfånget

GET /boundaries/{boundaryId}/resources/secretvaults

List all secretvaults across all resource groups

  • Autentisering: krävs
  • IAM-åtgärd: secretvault/read — utvärderas på resursen i sökvägen
  • Operationsnamn: ListAllSecretVaults

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte secretvault/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resources/secretvaults/config

Get list configuration for all secretvaults

  • Autentisering: krävs
  • IAM-åtgärd: secretvault/read — utvärderas på resursen i sökvägen
  • Operationsnamn: GetAllSecretVaultsConfig

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte secretvault/read på det utvärderade omfånget

Secrets

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/secretvaults/{resourceName}/secrets

List all secrets in a vault

  • Autentisering: krävs
  • IAM-åtgärd: secretvault/read — utvärderas på resursen i sökvägen
  • Operationsnamn: ListSecrets

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroup sökväg string Ja
resourceName sökväg string Ja
includeDeleted frågesträng boolean Nej

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte secretvault/read på det utvärderade omfånget

DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/secretvaults/{resourceName}/secrets/{secretName}

Delete a secret (soft-delete if vault has it enabled)

  • Autentisering: krävs
  • IAM-åtgärd: secretvault/writeSecrets — utvärderas på resursen i sökvägen; en dataåtgärd
  • Operationsnamn: DeleteSecret

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroup sökväg string Ja
resourceName sökväg string Ja
secretName sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte secretvault/writeSecrets på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/secretvaults/{resourceName}/secrets/{secretName}

Get the current value of a secret

  • Autentisering: krävs
  • IAM-åtgärd: secretvault/readSecrets — utvärderas på resursen i sökvägen; en dataåtgärd
  • Operationsnamn: GetSecret

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroup sökväg string Ja
resourceName sökväg string Ja
secretName sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte secretvault/readSecrets på det utvärderade omfånget

PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/secretvaults/{resourceName}/secrets/{secretName}

Create or update a secret value (creates a new version)

  • Autentisering: krävs
  • IAM-åtgärd: secretvault/writeSecrets — utvärderas på resursen i sökvägen; en dataåtgärd
  • Operationsnamn: SetSecret

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroup sökväg string Ja
resourceName sökväg string Ja
secretName sökväg string Ja

Begärans innehåll: SetSecretRequest

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte secretvault/writeSecrets på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/secretvaults/{resourceName}/secrets/{secretName}/purge

Permanently purge a soft-deleted secret

  • Autentisering: krävs
  • IAM-åtgärd: secretvault/writeSecrets — utvärderas på resursen i sökvägen; en dataåtgärd
  • Operationsnamn: PurgeDeletedSecret

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroup sökväg string Ja
resourceName sökväg string Ja
secretName sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte secretvault/writeSecrets på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/secretvaults/{resourceName}/secrets/{secretName}/recover

Recover a soft-deleted secret

  • Autentisering: krävs
  • IAM-åtgärd: secretvault/writeSecrets — utvärderas på resursen i sökvägen; en dataåtgärd
  • Operationsnamn: RecoverDeletedSecret

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroup sökväg string Ja
resourceName sökväg string Ja
secretName sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte secretvault/writeSecrets på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/secretvaults/{resourceName}/secrets/{secretName}/versions

List all versions of a secret

  • Autentisering: krävs
  • IAM-åtgärd: secretvault/readSecrets — utvärderas på resursen i sökvägen; en dataåtgärd
  • Operationsnamn: ListSecretVersions

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroup sökväg string Ja
resourceName sökväg string Ja
secretName sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte secretvault/readSecrets på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/secretvaults/{resourceName}/secrets/{secretName}/versions/{version}

Get a specific version of a secret

  • Autentisering: krävs
  • IAM-åtgärd: secretvault/readSecrets — utvärderas på resursen i sökvägen; en dataåtgärd
  • Operationsnamn: GetSecretVersion

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroup sökväg string Ja
resourceName sökväg string Ja
secretName sökväg string Ja
version sökväg integer Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte secretvault/readSecrets på det utvärderade omfånget

Secrets (External)

GET /vaults/{vaultName}/secrets/{name}

Get a secret using the globally unique vault name (for SDK/external access)

  • Autentisering: krävs
  • Operationsnamn: GetSecretByVaultName

Parametrar

Namn Plats Typ Obligatorisk
vaultName sökväg string Ja
name sökväg string Ja
version frågesträng integer Nej

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token

Övriga slutpunkter

GET /readyz

  • Autentisering: ingen — anonyma anrop accepteras
  • Operationsnamn: StackshipReadiness

Svar

Status Betydelse Innehåll

Scheman

SecretVaultDto

Egenskap Typ Kan vara null
boundary string Nej
boundaryId uuid Nej
clusterId uuid Nej
clusterName string Nej
collection string Nej
createdAt date-time Nej
enablePurgeProtection boolean Nej
id uuid Nej
name string Nej
phase string Ja
region string Nej
resourceGroup string Nej
secretCount integer Nej
softDeleteEnabled boolean Nej
softDeleteRetentionDays integer Nej
status string Nej
tags map (string) Nej
vaultUri string Ja

SetSecretRequest

Egenskap Typ Kan vara null
contentType string Ja
enabled boolean Nej
expiresOn date-time Ja
notBefore date-time Ja
tags map (string) Ja
value string Nej