Get a decryption profile

GET 
/decryption-profiles/:id

Get an existing decryption profile.

Request

Path Parameters

id uuidrequired

The UUID of the configuration resource

Responses

200

OK

application/json

Schema

Schema

oneOf

folder

folder stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The folder in which the resource is defined

snippet

snippet stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The snippet in which the resource is defined

device

device stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The device in which the resource is defined

id stringrequired

UUID of the resource

name stringrequired

Possible values: Value must match regular expression ^[A-Za-z0-9]{1}[A-Za-z0-9_\-\.\s]{0,}$

Must start with alphanumeric char and should contain only alphanemeric, underscore, hyphen, dot or space

ssl_forward_proxy object
auto_include_altname boolean
block_client_cert boolean
block_expired_certificate boolean
block_timeout_cert boolean
block_tls13_downgrade_no_resource boolean
block_unknown_cert boolean
block_unsupported_cipher boolean
block_unsupported_version boolean
block_untrusted_issuer boolean
restrict_cert_exts boolean
strip_alpn boolean
ssl_inbound_proxy object
block_if_hsm_unavailable boolean
block_if_no_resource boolean
block_unsupported_cipher boolean
block_unsupported_version boolean
ssl_no_proxy object
block_expired_certificate boolean
block_untrusted_issuer boolean
ssl_protocol_settings object

auth_algo_md5 boolean

Default value: true

auth_algo_sha1 boolean

Default value: true

auth_algo_sha256 boolean

Default value: true

auth_algo_sha384 boolean

Default value: true

enc_algo_3des boolean

Default value: true

enc_algo_aes_128_cbc boolean

Default value: true

enc_algo_aes_128_gcm boolean

Default value: true

enc_algo_aes_256_cbc boolean

Default value: true

enc_algo_aes_256_gcm boolean

Default value: true

enc_algo_chacha20_poly1305 boolean

Default value: true

enc_algo_rc4 boolean

Default value: true

keyxchg_algo_dhe boolean

Default value: true

keyxchg_algo_ecdhe boolean

Default value: true

keyxchg_algo_rsa boolean

Default value: true

max_version

Possible values: [sslv3, tls1-0, tls1-1, tls1-2, tls1-3, max]

Default value: tls1-2

min_version

Possible values: [sslv3, tls1-0, tls1-1, tls1-2, tls1-3]

Default value: tls1-0

Example (from schema)

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "name": "string",
  "ssl_forward_proxy": {
    "auto_include_altname": false,
    "block_client_cert": false,
    "block_expired_certificate": false,
    "block_timeout_cert": false,
    "block_tls13_downgrade_no_resource": false,
    "block_unknown_cert": false,
    "block_unsupported_cipher": false,
    "block_unsupported_version": false,
    "block_untrusted_issuer": false,
    "restrict_cert_exts": false,
    "strip_alpn": false
  },
  "ssl_inbound_proxy": {
    "block_if_hsm_unavailable": false,
    "block_if_no_resource": false,
    "block_unsupported_cipher": false,
    "block_unsupported_version": false
  },
  "ssl_no_proxy": {
    "block_expired_certificate": false,
    "block_untrusted_issuer": false
  },
  "ssl_protocol_settings": {
    "auth_algo_md5": true,
    "auth_algo_sha1": true,
    "auth_algo_sha256": true,
    "auth_algo_sha384": true,
    "enc_algo_3des": true,
    "enc_algo_aes_128_cbc": true,
    "enc_algo_aes_128_gcm": true,
    "enc_algo_aes_256_cbc": true,
    "enc_algo_aes_256_gcm": true,
    "enc_algo_chacha20_poly1305": true,
    "enc_algo_rc4": true,
    "keyxchg_algo_dhe": true,
    "keyxchg_algo_ecdhe": true,
    "keyxchg_algo_rsa": true
  }
}

400

Bad Request

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

input_format_mismatch

Input Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Input Format Mismatch: input-format=json",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

output_format_mismatch

Output Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Output Format Mismatch: output-format=json Accept=xml",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

missing_query_parameter

Missing Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Missing Query Parameter: name",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_query_parameter

Invalid Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Query Parameter: location=invalid",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

401

Unauthorized

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

auth_not_authenticated

Not Authenticated

{
  "_errors": [
    {
      "code": "E016",
      "message": "Not Authenticated",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_credential

Invalid Credential

{
  "_errors": [
    {
      "code": "E016",
      "message": "Invalid Credential",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

key_too_long

Key Too Long

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Too Long",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

key_expired

Key Expired

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Expired",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

need_password_change

Need Password Change

{
  "_errors": [
    {
      "code": "E016",
      "message": "The password needs to be changed.",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

403

Forbidden

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

auth_unauthorized

Unauthorized

{
  "_errors": [
    {
      "code": "E007",
      "message": "Unauthorized",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

404

Not Found

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

object_not_present

Object Not Present

{
  "_errors": [
    {
      "code": "E005",
      "message": "Object Not Present",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

default

General Errors

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

version_not_supported

Version Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Version Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

method_not_allowed

Method Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Method Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

action_not_supported

Action Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Action Not Supported: move",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

bad_xpath

Bad XPath

{
  "_errors": [
    {
      "code": "E013",
      "message": "Bad XPath",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_command

Invalid Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

malformed_command

Malformed Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Malformed Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

session_timeout

Session Timeout

{
  "_errors": [
    {
      "code": "4",
      "message": "Session Timeout",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Loading...