Prophecy.io Secrets API
The Secrets API from Prophecy.io — 2 operation(s) for secrets.
OpenAPI Specification
openapi: 3.0.3
info:
title: Prophecy Connections Secrets API
description: API for managing Prophecy connections
version: 1.0.0
tags:
- name: Secrets
paths:
/api/orchestration/fabric/{fabricId}/secret:
parameters:
- name: fabricId
in: path
description: The unique ID of the parent fabric
required: true
schema:
type: string
get:
tags:
- Secrets
summary: List secrets per fabric
description: List all secrets and their details from a specific fabric
operationId: listSecretsByFabric
parameters:
- $ref: '#/components/parameters/X-AUTH-TOKEN'
responses:
'200':
description: List of fabric secrets
content:
application/json:
schema:
type: object
required:
- success
properties:
success:
type: boolean
description: Indicates the request was successful.
enum:
- true
data:
type: object
properties:
secrets:
type: array
items:
type: object
properties:
kind:
type: string
description: Secret kind.
enum:
- prophecy
subKind:
type: string
description: Secret sub-type.
enum:
- text
- binary
- username_password
- m2m_oauth
properties:
type: object
properties:
id:
type: string
description: The unique identifier for the secret.
name:
type: string
description: The key name for the secret.
type:
type: string
description: The type of the resource.
enum:
- secret
description: Array of secret objects.
description: Response data containing the list of secrets.
example:
success: true
data:
secrets:
- kind: prophecy
subKind: text
properties:
id: '4656'
name: token_1
type: secret
- kind: prophecy
subKind: text
properties:
id: '4650'
name: service_account_1
type: secret
post:
tags:
- Secrets
summary: Add secret to fabric
description: Create a new secret in a specific fabric
operationId: createSecret
parameters:
- $ref: '#/components/parameters/X-AUTH-TOKEN'
requestBody:
description: Secret object to be created. Properties vary by `subKind`.
required: true
content:
application/json:
schema:
type: object
required:
- kind
- subKind
- properties
properties:
kind:
type: string
description: Secret management provider
enum:
- prophecy
subKind:
type: string
description: Secret sub-type
enum:
- text
- binary
- username_password
- m2m_oauth
properties:
type: object
description: 'Secret properties that vary by `subKind`.
Find specific properties in the **Secrets > Properties** section of the API documentation.'
example:
subKind: text
properties:
name: your-secret-name
value: your-secret-value
kind: prophecy
responses:
'200':
description: Secret created successfully
content:
application/json:
schema:
type: object
required:
- success
properties:
success:
type: boolean
description: Indicates the request was successful.
enum:
- true
data:
type: object
properties:
id:
type: string
description: The unique identifier for the created secret.
description: Response data containing the secret ID.
example:
success: true
data:
id: '4657'
/api/orchestration/fabric/{fabricId}/secret/id/{secretId}:
parameters:
- name: fabricId
in: path
description: The unique ID of the parent fabric
required: true
schema:
type: string
- name: secretId
in: path
description: The unique ID of the secret
required: true
schema:
type: string
get:
tags:
- Secrets
summary: Retrieve secret details
operationId: getSecretById
parameters:
- $ref: '#/components/parameters/X-AUTH-TOKEN'
responses:
'200':
description: Secret resource found
content:
application/json:
schema:
type: object
required:
- success
properties:
success:
type: boolean
description: Indicates the request was successful.
enum:
- true
data:
type: object
properties:
kind:
type: string
description: Secret kind (e.g., 'prophecy').
subKind:
type: string
description: Secret sub-type (e.g., 'text', 'm2m').
properties:
type: object
properties:
id:
type: string
description: The unique identifier for the secret.
name:
type: string
description: The key name for the secret.
type:
type: string
description: The type of the resource (e.g., 'secret').
description: Response data containing the secret details.
example:
success: true
data:
kind: prophecy
subKind: text
properties:
id: '4656'
name: accounttest
type: secret
put:
tags:
- Secrets
summary: Update secret
description: Update the properties of a specific secret
operationId: updateSecret
parameters:
- $ref: '#/components/parameters/X-AUTH-TOKEN'
requestBody:
description: Secret object with updated fields
required: true
content:
application/json:
schema:
type: object
required:
- kind
- subKind
- properties
properties:
kind:
type: string
description: Secret management provider
enum:
- prophecy
subKind:
type: string
description: Secret sub-type
enum:
- text
- binary
- username_password
- m2m_oauth
properties:
type: object
description: 'Secret properties that vary by `subKind`.
Find specific properties in the **Secrets > Properties** section of the API documentation.'
example:
kind: prophecy
subKind: text
properties:
name: service_account_1
value: <new-value>
responses:
'200':
description: Secret updated successfully
content:
application/json:
schema:
type: object
required:
- success
properties:
success:
type: boolean
description: Indicates the request was successful.
enum:
- true
data:
type: object
properties:
id:
type: string
description: The unique identifier for the updated secret.
description: Response data containing the secret ID.
example:
success: true
data:
id: '4656'
'400':
description: Bad request - Secret update failed
content:
application/json:
schema:
type: object
required:
- success
- message
properties:
success:
type: boolean
description: Indicates the request failed.
enum:
- false
message:
type: string
description: Error message describing why the request failed.
example:
success: false
message: 'Update Secret failed due to : Secret Store not found for Secret ID: propcy'
delete:
tags:
- Secrets
summary: Delete secret
description: Delete a specific secret by its ID
operationId: deleteSecret
parameters:
- $ref: '#/components/parameters/X-AUTH-TOKEN'
responses:
'200':
description: Secret deleted successfully
content:
application/json:
schema:
type: object
required:
- success
properties:
success:
type: boolean
description: Indicates the request was successful.
enum:
- true
data:
type: object
properties:
id:
type: string
description: The unique identifier for the deleted secret.
description: Response data containing the secret ID.
example:
success: true
data:
id: '4656'
components:
parameters:
X-AUTH-TOKEN:
name: X-AUTH-TOKEN
in: header
description: Prophecy authentication token. Required for all API requests.
required: true
schema:
type: string