Create Custom SMLTP Policy

curl --request POST \
  --url https://secureai.hiperai.ai/api/external/smltp-policies/active \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Custom Policy",
  "description": "Custom SMLTP policy for specific requirements",
  "policy": null,
  "setAsActive": false
}
'

import requests

url = "https://secureai.hiperai.ai/api/external/smltp-policies/active"

payload = {
    "name": "Custom Policy",
    "description": "Custom SMLTP policy for specific requirements",
    "policy": None,
    "setAsActive": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Custom Policy',
    description: 'Custom SMLTP policy for specific requirements',
    policy: null,
    setAsActive: false
  })
};

fetch('https://secureai.hiperai.ai/api/external/smltp-policies/active', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "message": "SMLTP policy created successfully",
  "policy": {
    "id": "custom-policy",
    "name": "Custom Policy",
    "description": "Custom SMLTP policy for specific requirements",
    "type": "custom",
    "isActive": false,
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

POST

smltp-policies

active

Create Custom SMLTP Policy

curl --request POST \
  --url https://secureai.hiperai.ai/api/external/smltp-policies/active \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Custom Policy",
  "description": "Custom SMLTP policy for specific requirements",
  "policy": null,
  "setAsActive": false
}
'

import requests

url = "https://secureai.hiperai.ai/api/external/smltp-policies/active"

payload = {
    "name": "Custom Policy",
    "description": "Custom SMLTP policy for specific requirements",
    "policy": None,
    "setAsActive": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Custom Policy',
    description: 'Custom SMLTP policy for specific requirements',
    policy: null,
    setAsActive: false
  })
};

fetch('https://secureai.hiperai.ai/api/external/smltp-policies/active', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "message": "SMLTP policy created successfully",
  "policy": {
    "id": "custom-policy",
    "name": "Custom Policy",
    "description": "Custom SMLTP policy for specific requirements",
    "type": "custom",
    "isActive": false,
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

SMLTP-Richtlinie erstellen

Erstellen Sie eine neue SMLTP-Sicherheitsrichtlinie (Secure Model Language Transfer Protocol) für Ihr Konto.

Endpunkt

POST /smltp-policies

Beschreibung

Erstellen Sie eine neue benutzerdefinierte SMLTP-Richtlinie. Nur Administratorzugriff erforderlich.

Authentifizierung

Erforderlich: API-Schlüssel mit Administratorrechten

Authorization: Bearer sk-your-api-key-here

Anforderungstext

Parameter	Geben Sie	ein Erforderlich	Beschreibung
`name`	Zeichenfolge	Ja	Richtlinienname
`description`	Zeichenfolge	Ja	Richtlinienbeschreibung
`policy`	Objekt	Ja	Richtlinienkonfigurationsobjekt
`setAsActive`	boolescher Wert	Nein	Ob diese Richtlinie sofort als aktiv festgelegt werden soll (Standard: false)

Beispielanfrage

{
  "name": "Custom Privacy Policy",
  "description": "Enhanced privacy protection for sensitive data",
  "policy": {
    // Policy configuration object
  },
  "setAsActive": false
}

Erfolgsantwort

Statuscode: 201 Created

{
  "success": true,
  "message": "SMLTP policy created successfully",
  "policy": {
    "id": "custom-privacy-policy",
    "name": "Custom Privacy Policy",
    "description": "Enhanced privacy protection for sensitive data",
    "type": "custom",
    "isActive": false,
    "createdAt": "2024-01-20T15:30:00.000Z"
  }
}

Antwortfelder

Feld	Geben Sie	ein Beschreibung
`success`	boolescher Wert	Zeigt an, ob der Vorgang erfolgreich war
`message`	Zeichenfolge	Erfolgsmeldung
`policy`	Objekt	Erstelltes Richtlinienobjekt
`policy.id`	Zeichenfolge	Richtlinien-ID (aus dem Namen generiert)
`policy.name`	Zeichenfolge	Richtlinienname
`policy.description`	Zeichenfolge	Richtlinienbeschreibung
`policy.type`	Zeichenfolge	Richtlinientyp („benutzerdefiniert“)
`policy.isActive`	boolescher Wert	Ob die Richtlinie derzeit aktiv ist
`policy.createdAt`	Zeichenfolge	Erstellungszeitstempel

Beispielverwendung

JavaScript

const createSmltpPolicy = async (policyData) => {
  const response = await fetch('https://{customer.name}.hiperai.ai/api/external/smltp-policies', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer sk-your-api-key-here',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify(policyData)
  });
  
  return await response.json();
};

// Example usage
const policyData = {
  name: "Custom Privacy Policy",
  description: "Enhanced privacy protection for sensitive data",
  policy: {
    // Policy configuration object
  },
  setAsActive: false
};

const result = await createSmltpPolicy(policyData);
console.log('Created policy:', result.policy.id);

Python

import requests

def create_smltp_policy(policy_data):
    url = "https://{customer.name}.hiperai.ai/api/external/smltp-policies"
    headers = {
        "Authorization": "Bearer sk-your-api-key-here",
        "Content-Type": "application/json"
    }
    
    response = requests.post(url, headers=headers, json=policy_data)
    return response.json()

# Example usage
policy_data = {
    "name": "Custom Privacy Policy",
    "description": "Enhanced privacy protection for sensitive data",
    "policy": {
        # Policy configuration object
    },
    "setAsActive": False
}

result = create_smltp_policy(policy_data)
print("Created policy:", result["policy"]["id"])

cURL

curl -X POST "https://{customer.name}.hiperai.ai/api/external/smltp-policies" \
  -H "Authorization: Bearer sk-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Custom Privacy Policy",
    "description": "Enhanced privacy protection for sensitive data",
    "policy": {
      // Policy configuration object
    },
    "setAsActive": false
  }'

Fehlerantworten

400 Ungültige Anfrage

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Policy name is required",
    "details": {
      "field": "name",
      "value": null
    }
  }
}

401 Nicht autorisiert

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}

403 Verboten

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "Admin privileges required"
  }
}

409 Konflikt

{
  "success": false,
  "error": {
    "code": "POLICY_NAME_EXISTS",
    "message": "Policy name already exists"
  }
}

429 Zu viele Anfragen

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded",
    "retryAfter": 60
  }
}

Anwendungsfälle

Benutzerdefinierte Sicherheit: Erstellen Sie Richtlinien, die auf Ihre Bedürfnisse zugeschnitten sind
Compliance: Implementieren Sie spezifische regulatorische Anforderungen
Risikomanagement: Definieren Sie Sicherheitsmaßnahmen zur Risikominderung
Datenschutz: Legen Sie Datenschutz- und Datenverarbeitungsregeln fest
Richtlinienverwaltung: Erstellen und verwalten Sie benutzerdefinierte SMLTP-Richtlinien

Tarifbegrenzungen

Standard: 50 Anfragen pro Minute
Täglich: 5.000 Anfragen pro Tag
Monatlich: 150.000 Anfragen pro Monat

Notizen

– Für diesen Endpunkt sind Administratorrechte erforderlich

Erforderliche Felder: Name, Beschreibung und Richtlinie sind erforderlich
Richtlinien-ID: Wird aus dem Namen generiert (Kleinbuchstaben, Bindestriche für Leerzeichen)
Eindeutige Namen: Richtliniennamen müssen eindeutig sein
Aktiv setzen: Kann optional sofort als aktiv gesetzt werden
Flache Antwort: Die Antwort ist nicht unter dem Datenobjekt verschachtelt

Autorisierungen

Authorization

string

header

erforderlich

API key authentication using Bearer token format. Example: Authorization: Bearer sk-your-api-key-here

Body

application/json

name

string

erforderlich

Policy name

Beispiel:

"Custom Policy"

description

string

erforderlich

Policy description

Beispiel:

"Custom SMLTP policy for specific requirements"

policy

object

erforderlich

Policy configuration object

Beispiel:

null

setAsActive

boolean

Standard:false

Whether to set this policy as active immediately

Beispiel:

false

Antwort

Custom policy created successfully

success

boolean

Beispiel:

true

message

string

Beispiel:

"SMLTP policy created successfully"

policy

object

Show child attributes

Erste Schritte & Setup

Modelle & KI-Generierung

Knowledge Base & RAG

Sicherheit, Guardrails & Auditierung

Benutzer & Zugriff (IAM)

Abrechnung, Kontingente & Webhooks

Erstellen Sie eine SMLTP-Richtlinie

SMLTP-Richtlinie erstellen

Endpunkt

Beschreibung

Authentifizierung

Anforderungstext

Beispielanfrage

Erfolgsantwort

Antwortfelder

Beispielverwendung

JavaScript

Python

cURL

Fehlerantworten

400 Ungültige Anfrage

401 Nicht autorisiert

403 Verboten

409 Konflikt

429 Zu viele Anfragen

Anwendungsfälle

Tarifbegrenzungen

Notizen

Autorisierungen

Body

Antwort

​SMLTP-Richtlinie erstellen

​Endpunkt

​Beschreibung

​Authentifizierung

​Anforderungstext

​Beispielanfrage

​Erfolgsantwort

​Antwortfelder

​Beispielverwendung

​JavaScript

​Python

​cURL

​Fehlerantworten

​400 Ungültige Anfrage

​401 Nicht autorisiert

​403 Verboten

​409 Konflikt

​429 Zu viele Anfragen

​Anwendungsfälle

​Tarifbegrenzungen

​Notizen

Autorisierungen

Body

Antwort

SMLTP-Richtlinie erstellen

Endpunkt

Beschreibung

Authentifizierung

Anforderungstext

Beispielanfrage

Erfolgsantwort

Antwortfelder

Beispielverwendung

JavaScript

Python

cURL

Fehlerantworten

400 Ungültige Anfrage

401 Nicht autorisiert

403 Verboten

409 Konflikt

429 Zu viele Anfragen

Anwendungsfälle

Tarifbegrenzungen

Notizen