Create an organization preset

POST/api/public/v1/policy-presets beta

A new organization preset from its source: the confirmed intent policies of a draft or the ratified intent policies of a live AIP (intent_policy_ids), the chosen rules of a preset (preset), or typed sentences with their dimension (sentences). Rules are copied by the server; a sentence already in the preset with the same dimension is skipped and returned in skipped. 409 PRESET_NAME_EXISTS for a name taken in the organization (case-insensitive) or a built-in title; 422 PRESET_EMPTY when no rule remains.

cURL

curl --fail-with-body -X POST 'https://app.openlatch.ai/api/public/v1/policy-presets' \
  -H "Authorization: Bearer $OPENLATCH_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"name":"<preset_name>","description":"Created by the API examples.","source":{"sentences":[{"sentence":"Block a direct push to main.","dimension":"security"}]}}'

Python

import json
import os
import urllib.request

body = '{"name":"<preset_name>","description":"Created by the API examples.","source":{"sentences":[{"sentence":"Block a direct push to main.","dimension":"security"}]}}'
request = urllib.request.Request(
    'https://app.openlatch.ai/api/public/v1/policy-presets',
    method='POST',
    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 POST 'https://app.openlatch.ai/api/public/v1/policy-presets' \
  -H "Authorization: Bearer $OPENLATCH_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"name":"<preset_name>","description":"Created by the API examples.","source":{"sentences":[{"sentence":"Block a direct push to main.","dimension":"security"}]}}' | jq .

PowerShell

$headers = @{
  Authorization = "Bearer $env:OPENLATCH_API_KEY"
}
$body = '{"name":"<preset_name>","description":"Created by the API examples.","source":{"sentences":[{"sentence":"Block a direct push to main.","dimension":"security"}]}}'
Invoke-RestMethod -Method POST -Uri 'https://app.openlatch.ai/api/public/v1/policy-presets' -Headers $headers -ContentType 'application/json; charset=utf-8' -Body $body | ConvertTo-Json -Depth 20

Autorisation

Rôle dans l’organisation	Ce point de terminaison
owner	Autorisé
admin	Autorisé
editor	Autorisé
viewer	Non autorisé

Une clé porte le rôle que son propriétaire détient dans l’organisation. Voir Authentification.

Portée de clé d’API : presets:write

Paramètres d’en-tête

Paramètre	Type	Description
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.

Corps de la requête

Champ	Type	Description
description	string or null
name	string	Obligatoire.
source	object	Obligatoire. Exactly one of the three: intent policy ids, a preset selection, or typed sentences.
source.intent_policy_ids	array of string (uuid) or null
source.preset	object or null
source.preset.intents	array of object	Obligatoire.
source.preset.key	string	Obligatoire.
source.sentences	array of object or null

Réponse

• 201 Created — l’appel a réussi.
• 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, NOT_RATIFIED, PRESET_CHANGED, PRESET_EMPTY, PRESET_NAME_EXISTS
• 422 Unprocessable Content — IDEMPOTENCY_KEY_REUSED, INVALID_ID, PRESET_EMPTY, SELECTION_TOO_LARGE, 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

Champs de la réponse

Champ	Type	Description
data	object	Obligatoire. A create or an add: the preset, and the sentences not added because already in it.
data.created_by	object or null
data.created_by.name	string	Obligatoire.
data.default_selected	boolean	Obligatoire. False for a framework preset, otherwise true.
data.description	string	Obligatoire.
data.framework	object or null	Obligatoire. Set on a framework preset; null on every other.
data.framework.notice	object or null	Obligatoire.
data.framework.source	object	Obligatoire.
data.key	string	Obligatoire.
data.kind	string — one of builtin, organization	Obligatoire.
data.revision	integer or null
data.rules	array of object	Obligatoire.
data.rules[].capability	object or null
data.rules[].citation	object or null	Obligatoire. 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	Obligatoire.
data.rules[].intent_key	string	Obligatoire.
data.rules[].sentence	string	Obligatoire.
data.skipped	array of string
data.title	string	Obligatoire.

Exemple de réponse

{
  "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"
      }
    ],
    "skipped": [
      "string"
    ],
    "title": "string"
  }
}

Voir aussi

• GET Lister les préréglages de politiques
• DELETE Delete an organization preset
• PATCH Rename or describe an organization preset