mirror of
https://github.com/awatertrevi/infisical.git
synced 2026-09-22 13:39:35 +00:00
Address PR comments
This commit is contained in:
Carlos Monastyrski
@@ -0,0 +1,151 @@
|
||||
---
|
||||
title: "Create Azure Key Vault PKI Sync"
|
||||
openapi: "POST /api/v1/pki/syncs/azure-key-vault"
|
||||
---
|
||||
|
||||
<Info>
|
||||
This endpoint creates a new Azure Key Vault PKI sync for a specified project.
|
||||
</Info>
|
||||
|
||||
## Request
|
||||
|
||||
<ParamField body="name" type="string" required>
|
||||
Name of the PKI sync (1-64 characters)
|
||||
</ParamField>
|
||||
|
||||
<ParamField body="description" type="string" optional>
|
||||
Description of the PKI sync
|
||||
</ParamField>
|
||||
|
||||
<ParamField body="isAutoSyncEnabled" type="boolean" default="true">
|
||||
Whether automatic synchronization is enabled when certificates are issued
|
||||
</ParamField>
|
||||
|
||||
<ParamField body="destinationConfig" type="object" required>
|
||||
Azure Key Vault specific configuration
|
||||
<Expandable title="properties">
|
||||
<ParamField body="vaultBaseUrl" type="string" required>
|
||||
Base URL of the Azure Key Vault (e.g., "https://my-vault.vault.azure.net/")
|
||||
</ParamField>
|
||||
</Expandable>
|
||||
</ParamField>
|
||||
|
||||
<ParamField body="syncOptions" type="object" default="{}">
|
||||
Sync-specific options and settings
|
||||
</ParamField>
|
||||
|
||||
<ParamField body="subscriberId" type="string" optional>
|
||||
ID of the PKI subscriber to connect this sync to. If provided, certificates issued by this subscriber will be automatically synced to Azure Key Vault.
|
||||
</ParamField>
|
||||
|
||||
<ParamField body="connectionId" type="string" required>
|
||||
ID of the Azure Key Vault app connection to use for this sync
|
||||
</ParamField>
|
||||
|
||||
<ParamField body="projectId" type="string" required>
|
||||
ID of the project to create the PKI sync in
|
||||
</ParamField>
|
||||
|
||||
## Response
|
||||
|
||||
Returns the created Azure Key Vault PKI sync object with the same structure as the list endpoint response.
|
||||
|
||||
<ResponseField name="id" type="string">
|
||||
Unique identifier for the created PKI sync
|
||||
</ResponseField>
|
||||
|
||||
<ResponseField name="name" type="string">
|
||||
Name of the PKI sync
|
||||
</ResponseField>
|
||||
|
||||
<ResponseField name="description" type="string" optional>
|
||||
Description of the PKI sync
|
||||
</ResponseField>
|
||||
|
||||
<ResponseField name="destination" type="string">
|
||||
Always "azure-key-vault"
|
||||
</ResponseField>
|
||||
|
||||
<ResponseField name="isAutoSyncEnabled" type="boolean">
|
||||
Whether automatic synchronization is enabled
|
||||
</ResponseField>
|
||||
|
||||
<ResponseField name="destinationConfig" type="object">
|
||||
Azure Key Vault specific configuration
|
||||
</ResponseField>
|
||||
|
||||
<ResponseField name="syncOptions" type="object">
|
||||
Sync-specific options and settings
|
||||
</ResponseField>
|
||||
|
||||
<ResponseField name="projectId" type="string">
|
||||
ID of the project this sync belongs to
|
||||
</ResponseField>
|
||||
|
||||
<ResponseField name="subscriberId" type="string" optional>
|
||||
ID of the PKI subscriber this sync is connected to
|
||||
</ResponseField>
|
||||
|
||||
<ResponseField name="connectionId" type="string">
|
||||
ID of the Azure Key Vault app connection used for this sync
|
||||
</ResponseField>
|
||||
|
||||
<ResponseField name="createdAt" type="string">
|
||||
Timestamp when the PKI sync was created
|
||||
</ResponseField>
|
||||
|
||||
<ResponseField name="updatedAt" type="string">
|
||||
Timestamp when the PKI sync was last updated
|
||||
</ResponseField>
|
||||
|
||||
<RequestExample>
|
||||
```bash cURL
|
||||
curl -X POST "https://app.infisical.com/api/v1/pki/syncs/azure-key-vault" \
|
||||
-H "Authorization: Bearer <your-api-key>" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"name": "Production Azure Key Vault Sync",
|
||||
"description": "Sync certificates to production Key Vault",
|
||||
"isAutoSyncEnabled": true,
|
||||
"destinationConfig": {
|
||||
"vaultBaseUrl": "https://my-vault.vault.azure.net/"
|
||||
},
|
||||
"syncOptions": {},
|
||||
"subscriberId": "sub_12345",
|
||||
"connectionId": "conn_12345",
|
||||
"projectId": "proj_12345"
|
||||
}'
|
||||
```
|
||||
</RequestExample>
|
||||
|
||||
<ResponseExample>
|
||||
```json Response
|
||||
{
|
||||
"id": "ps_12345",
|
||||
"name": "Production Azure Key Vault Sync",
|
||||
"description": "Sync certificates to production Key Vault",
|
||||
"destination": "azure-key-vault",
|
||||
"isAutoSyncEnabled": true,
|
||||
"destinationConfig": {
|
||||
"vaultBaseUrl": "https://my-vault.vault.azure.net/"
|
||||
},
|
||||
"syncOptions": {},
|
||||
"projectId": "proj_12345",
|
||||
"subscriberId": "sub_12345",
|
||||
"connectionId": "conn_12345",
|
||||
"syncStatus": null,
|
||||
"lastSyncedAt": null,
|
||||
"lastSyncMessage": null,
|
||||
"removeStatus": null,
|
||||
"lastRemovedAt": null,
|
||||
"lastRemoveMessage": null,
|
||||
"connection": {
|
||||
"id": "conn_12345",
|
||||
"name": "Azure Production Connection",
|
||||
"app": "azure-key-vault"
|
||||
},
|
||||
"createdAt": "2023-11-01T10:00:00Z",
|
||||
"updatedAt": "2023-11-01T10:00:00Z"
|
||||
}
|
||||
```
|
||||
</ResponseExample>
|
||||
Reference in New Issue
Block a user