Rename or describe an organization preset

PATCH/api/public/v1/policy-presets/{key} beta

revision is the one the caller read; a stale one answers 409 PRESET_CHANGED. description: null clears it. 409 PRESET_READ_ONLY for a built-in preset; 422 EMPTY_PATCH with neither field.

cURL

curl --fail-with-body -X PATCH 'https://app.openlatch.ai/api/public/v1/policy-presets/<preset_key>' \
  -H "Authorization: Bearer $OPENLATCH_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"revision":<revision>,"description":"Updated by the API examples."}'

Python

import json
import os
import urllib.request

body = '{"revision":<revision>,"description":"Updated by the API examples."}'
request = urllib.request.Request(
    'https://app.openlatch.ai/api/public/v1/policy-presets/<preset_key>',
    method='PATCH',
    data=body.encode(),
    headers={
        'Authorization': 'Bearer ' + os.environ['OPENLATCH_API_KEY'],
        'Content-Type': 'application/json',
    },
)
with urllib.request.urlopen(request) as response:
    text = response.read().decode()
    print(json.dumps(json.loads(text), indent=2) if text else response.status)

Bash

#!/usr/bin/env bash
set -euo pipefail

curl -sS --fail-with-body -X PATCH 'https://app.openlatch.ai/api/public/v1/policy-presets/<preset_key>' \
  -H "Authorization: Bearer $OPENLATCH_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"revision":<revision>,"description":"Updated by the API examples."}' | jq .

PowerShell

$headers = @{
  Authorization = "Bearer $env:OPENLATCH_API_KEY"
}
$body = '{"revision":<revision>,"description":"Updated by the API examples."}'
Invoke-RestMethod -Method PATCH -Uri 'https://app.openlatch.ai/api/public/v1/policy-presets/<preset_key>' -Headers $headers -ContentType 'application/json; charset=utf-8' -Body $body | ConvertTo-Json -Depth 20

Autorización

Rol en la organización	Este punto de conexión
owner	Permitido
admin	Permitido
editor	Permitido
viewer	No permitido

Una clave tiene el rol que su propietario ocupa en la organización. Consulte Autenticación.

Ámbito de la clave de API: presets:write

Parámetros de ruta

Parámetro	Tipo	Descripción
key	string	Obligatorio.

Parámetros de encabezado

Parámetro	Tipo	Descripción
Idempotency-Key	string or null	Optional. Makes the request safe to retry: the same key and the same request, within 24 hours, returns the stored response with Idempotent-Replayed: true and runs once.

Cuerpo de la solicitud

Campo	Tipo	Descripción
description	string or null
name	string or null
revision	integer	Obligatorio.

Respuesta

• 200 OK — la llamada se completó correctamente.
• 400 Bad Request — BAD_REQUEST
• 401 Unauthorized — UNAUTHORIZED
• 402 Payment Required — license_expired
• 403 Forbidden — FEATURE_DISABLED, FORBIDDEN, INSUFFICIENT_SCOPE
• 404 Not Found — NOT_FOUND
• 409 Conflict — IDEMPOTENCY_IN_PROGRESS, PRESET_CHANGED, PRESET_NAME_EXISTS, PRESET_READ_ONLY
• 422 Unprocessable Content — EMPTY_PATCH, IDEMPOTENCY_KEY_REUSED, INVALID_ID, VALIDATION_ERROR
• 429 Too Many Requests — TOO_MANY_REQUESTS
• 500 Internal Server Error — INTERNAL_SERVER_ERROR, tenant_isolation_violation
• 503 Service Unavailable — FEATURE_STATE_UNAVAILABLE, SERVICE_UNAVAILABLE

Campos de la respuesta

Campo	Tipo	Descripción
data	object	Obligatorio. One preset: built-in (read-only for every role) or the organization's own.
data.created_by	object or null
data.created_by.name	string	Obligatorio.
data.default_selected	boolean	Obligatorio. False for a framework preset, otherwise true.
data.description	string	Obligatorio.
data.framework	object or null	Obligatorio. Set on a framework preset; null on every other.
data.framework.notice	object or null	Obligatorio.
data.framework.source	object	Obligatorio.
data.key	string	Obligatorio.
data.kind	string — one of builtin, organization	Obligatorio.
data.revision	integer or null
data.rules	array of object	Obligatorio.
data.rules[].capability	object or null
data.rules[].citation	object or null	Obligatorio. What the rule cites, for a framework preset's rule; null for every other.
data.rules[].dimension	string — one of quality, economics, security, safety, compliance	Obligatorio.
data.rules[].intent_key	string	Obligatorio.
data.rules[].sentence	string	Obligatorio.
data.title	string	Obligatorio.

Ejemplo de respuesta

{
  "data": {
    "created_by": {
      "name": "release-bot"
    },
    "default_selected": false,
    "description": "string",
    "framework": {
      "notice": "string",
      "source": {
        "framework_url": "https://app.openlatch.ai/",
        "github_url": "https://app.openlatch.ai/",
        "license_name": "release-bot",
        "license_url": "https://app.openlatch.ai/",
        "name": "release-bot",
        "source_commit": "string",
        "source_date": "string"
      }
    },
    "key": "string",
    "kind": "builtin",
    "revision": 3,
    "rules": [
      {
        "capability": "enforce",
        "citation": {
          "entries": [
            {}
          ],
          "items": [
            {}
          ]
        },
        "dimension": "quality",
        "intent_key": "string",
        "sentence": "string"
      }
    ],
    "title": "string"
  }
}

Véase también

• GET Listar los preajustes de políticas
• POST Create an organization preset
• DELETE Delete an organization preset