Create credential

Create a new credential. The secret is returned once and never readable again.

post/credentials

Request body

Example request

{
  "api": {
    "name": "stripe",
    "vendor": "stripe.com",
    "version": "2024-04-10"
  },
  "field_name": "Authorization",
  "key": "sk_live_…",
  "location": "header",
  "name": "Stripe live key",
  "provider": "static",
  "type": "api_key"
}

Response

Successful Response

secretobject required

Example response

{
  "credential": {
    "active": true,
    "api": {
      "name": "stripe",
      "vendor": "stripe.com",
      "version": "2024-04-10"
    },
    "created_at": "2026-01-15T09:30:00Z",
    "credential_id": "cred_01HZX9...",
    "details": {
      "field_name": "Authorization",
      "hint": "…live_abcd",
      "location": "header"
    },
    "name": "Stripe live key",
    "provider": "static",
    "type": "api_key"
  }
}

Changes

Changed in 8 of the 85 revisions of this API.143274

Aug 5, 20264d30025450c712See the full diff
- ●
  added the new sigv4 enum value to the credential/type response property for the response status 201
  response-property-enum-value-added
- ○
  added sigv4 mapping keys to the request discriminator
  request-body-discriminator-mapping-added
- ○
  added Sigv4CreateRequest to the request body oneOf list
  request-body-one-of-added
Jul 31, 20263746d110464c6See the full diff
- ○
  added the new optional request property oneOf[subschema #1: BearerTokenCreateRequest]/api/catalog_api_id
  new-optional-request-property
- ○
  added the new optional request property oneOf[subschema #2: ApiKeyCreateRequest]/api/catalog_api_id
  new-optional-request-property
- ○
  added the new optional request property oneOf[subschema #3: BasicAuthCreateRequest]/api/catalog_api_id
  new-optional-request-property
- ○
  added the new optional request property oneOf[subschema #4: OAuth2CreateRequest]/api/catalog_api_id
  new-optional-request-property
- ○
  added the new optional request property oneOf[subschema #5: NoAuthCreateRequest]/api/catalog_api_id
  new-optional-request-property
- ○
  added the optional property credential/catalog_api_id to the response with the 201 status
  response-optional-property-added
Jul 24, 20267f8d4d76abcd12See the full diff
- ●
  added the new no_auth enum value to the credential/type response property for the response status 201
  response-property-enum-value-added
- ○
  added no_auth mapping keys to the request discriminator
  request-body-discriminator-mapping-added
- ○
  added NoAuthCreateRequest to the request body oneOf list
  request-body-one-of-added
Jul 23, 2026e7b87904bdbb1See the full diff
- ○
  added the optional property credential/created_by to the response with the 201 status
  response-optional-property-added
Jul 1, 2026d65fcba0d25a42422See the full diff
- ▲
  the request's body type/format changed from object/ to /
  request-body-type-changed
- ▲
  the detail response's property type/format changed from array/ to string/ for status 422
  response-property-type-changed
- ▲
  removed the required property id from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property label from the response with the 201 status
  response-required-property-removed
- ●
  removed the request property api_id
  request-property-removed
- ●
  removed the request property auth_type
  request-property-removed
- ●
  removed the request property description
  request-property-removed
- ●
  removed the request property identity
  request-property-removed
- ●
  removed the request property label
  request-property-removed
- ●
  removed the request property routes
  request-property-removed
- ●
  removed the request property scheme
  request-property-removed
- ●
  removed the request property server_variables
  request-property-removed
- ●
  removed the request property value
  request-property-removed
- ●
  removed the optional property account_id from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property api_id from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property app_slug from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property auth_type from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property created_at from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property description from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property health_checked_at from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property healthy from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property identity from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property last_used_at from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property routes from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property scheme from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property server_variables from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property synced_at from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property updated_at from the response with the 201 status
  response-optional-property-removed
- ○
  api operation id create_credentials_post removed and replaced with createCredential
  api-operation-id-removed
- ○
  the endpoint scheme security BearerAuth was added to the API
  api-security-added
- ○
  the endpoint scheme security HumanLogin was removed from the API
  api-security-removed
- ○
  api tag Credentials added
  api-tag-added
- ○
  api tag credentials removed
  api-tag-removed
- ○
  added request discriminator
  request-body-discriminator-added
- ○
  added BearerTokenCreateRequest ApiKeyCreateRequest BasicAuthCreateRequest OAuth2CreateRequest to the request body oneOf list
  request-body-one-of-added
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 422
  response-media-type-name-specialized
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 403
  response-non-success-status-added
- ○
  added the non-success response with the status 500
  response-non-success-status-added
- ○
  added the non-success response with the status 503
  response-non-success-status-added
- ○
  added the optional property code to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property errors to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property instance to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property title to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property type to the response with the 422 status
  response-optional-property-added
- ○
  the response property detail became required for the status 422
  response-property-became-required
- ○
  added the required property credential to the response with the 201 status
  response-required-property-added
- ○
  added the required property secret to the response with the 201 status
  response-required-property-added
This revision also has 61 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 16, 2026ba15fae438928See the full diff
- ○
  added the new optional request property description
  new-optional-request-property
- ○
  added the new JenticApiKey enum value to the request property auth_type/anyOf[subschema #1]/
  request-property-enum-value-added
- ○
  added the new oauth2 enum value to the request property auth_type/anyOf[subschema #1]/
  request-property-enum-value-added
- ○
  added the new pipedream_oauth enum value to the request property auth_type/anyOf[subschema #1]/
  request-property-enum-value-added
- ○
  added the optional property description to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property health_checked_at to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property healthy to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property last_used_at to the response with the 201 status
  response-optional-property-added
Apr 14, 2026bd463fcefb149See the full diff
- ○
  added the new optional request property routes
  new-optional-request-property
- ○
  added the new optional request property scheme
  new-optional-request-property
- ○
  added the new optional request property server_variables
  new-optional-request-property
- ○
  the request property value became optional
  request-property-became-optional
- ○
  the value request property default value was added
  request-property-default-value-added
- ○
  added the new none enum value to the request property auth_type/anyOf[subschema #1]/
  request-property-enum-value-added
- ○
  added the optional property routes to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property scheme to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property server_variables to the response with the 201 status
  response-optional-property-added
Apr 13, 202676e8f606372810624See the full diff
- ▲
  added the new required request property label
  new-required-request-property
- ▲
  added the new required request property value
  new-required-request-property
- ▲
  removed BearerTokenCreateRequest ApiKeyCreateRequest BasicAuthCreateRequest OAuth2CreateRequest from the request body oneOf list
  request-body-one-of-removed
- ▲
  the request's body type/format changed from / to object/
  request-body-type-changed
- ▲
  media type application/problem+json was changed to a more general media type application/json for the response status 422
  response-media-type-name-generalized
- ▲
  the response property detail became optional for the status 422
  response-property-became-optional
- ▲
  the detail response property's maxLength was unset from 4096 for the response status 422
  response-property-max-length-unset
- ▲
  the detail response's property type/format changed from string/ to array/ for status 422
  response-property-type-changed
- ▲
  removed the required property credential from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property secret from the response with the 201 status
  response-required-property-removed
- ●
  removed the optional property code from the response with the 422 status
  response-optional-property-removed
- ●
  removed the optional property errors from the response with the 422 status
  response-optional-property-removed
- ●
  removed the optional property instance from the response with the 422 status
  response-optional-property-removed
- ●
  removed the optional property status from the response with the 422 status
  response-optional-property-removed
- ●
  removed the optional property title from the response with the 422 status
  response-optional-property-removed
- ●
  removed the optional property type from the response with the 422 status
  response-optional-property-removed
- ○
  api operation id createCredential removed and replaced with create_credentials_post
  api-operation-id-removed
- ○
  the endpoint scheme security HumanLogin was added to the API
  api-security-added
- ○
  the endpoint scheme security BearerAuth was removed from the API
  api-security-removed
- ○
  api tag credentials added
  api-tag-added
- ○
  api tag Credentials removed
  api-tag-removed
- ○
  added the new optional request property api_id
  new-optional-request-property
- ○
  added the new optional request property auth_type
  new-optional-request-property
- ○
  added the new optional request property identity
  new-optional-request-property
- ○
  removed request discriminator
  request-body-discriminator-removed
- ○
  removed the non-success response with the status 400
  response-non-success-status-removed
- ○
  removed the non-success response with the status 401
  response-non-success-status-removed
- ○
  removed the non-success response with the status 403
  response-non-success-status-removed
- ○
  removed the non-success response with the status 500
  response-non-success-status-removed
- ○
  removed the non-success response with the status 503
  response-non-success-status-removed
- ○
  added the optional property account_id to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property api_id to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property app_slug to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property auth_type to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property created_at to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property identity to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property synced_at to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property updated_at to the response with the 201 status
  response-optional-property-added
- ○
  added the required property id to the response with the 201 status
  response-required-property-added
- ○
  added the required property label to the response with the 201 status
  response-required-property-added
This revision also has 179 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history