Scaleway · Schema

Scaleway Secret

A secret stored in Scaleway Secret Manager

AICloud ComputingContainersDatabaseEuropean CloudInfrastructureKubernetesServerlessStorage

Properties

Name	Type	Description
id	string	Unique identifier of the secret
name	string	Name of the secret (must be unique within a project)
status	string	Current status of the secret
project_id	string	Project ID the secret belongs to
organization_id	string	Organization ID that owns the secret
region	string	Region where the secret is stored
tags	array	User-defined tags for the secret
description	string	Human-readable description of the secret
type	string	Type of secret being stored
version_count	integer	Number of versions of this secret
is_managed	boolean	Whether the secret is managed by Scaleway
path	string	Path for organizing secrets in a hierarchy
created_at	string	Timestamp when the secret was created
updated_at	string	Timestamp when the secret was last updated

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/scaleway/main/json-schema/scaleway-secret-schema.json",
  "title": "Scaleway Secret",
  "description": "A secret stored in Scaleway Secret Manager",
  "type": "object",
  "required": ["id", "name", "status", "project_id", "region"],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier of the secret"
    },
    "name": {
      "type": "string",
      "description": "Name of the secret (must be unique within a project)",
      "pattern": "^[a-zA-Z0-9_-]+$",
      "maxLength": 255
    },
    "status": {
      "type": "string",
      "enum": ["ready", "locked"],
      "description": "Current status of the secret"
    },
    "project_id": {
      "type": "string",
      "format": "uuid",
      "description": "Project ID the secret belongs to"
    },
    "organization_id": {
      "type": "string",
      "format": "uuid",
      "description": "Organization ID that owns the secret"
    },
    "region": {
      "type": "string",
      "description": "Region where the secret is stored",
      "examples": ["fr-par", "nl-ams", "pl-waw"]
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "User-defined tags for the secret"
    },
    "description": {
      "type": "string",
      "description": "Human-readable description of the secret",
      "maxLength": 1000
    },
    "type": {
      "type": "string",
      "enum": ["unknown_secret_type", "opaque", "certificate", "key_value", "basic_credentials", "database_credentials", "ssh_key"],
      "description": "Type of secret being stored"
    },
    "version_count": {
      "type": "integer",
      "minimum": 0,
      "description": "Number of versions of this secret"
    },
    "is_managed": {
      "type": "boolean",
      "description": "Whether the secret is managed by Scaleway"
    },
    "path": {
      "type": "string",
      "description": "Path for organizing secrets in a hierarchy"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the secret was created"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the secret was last updated"
    }
  }
}