Anypoint Security Policies API

Delete organization Security Fabric data purgeOrganizationData

DELETE

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Deletes all the data belonging to an organization, sub-organization from Security Fabric Edge and Anypoint Security Policies

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

Successful. Returns zero length body.

Delete environment Security Fabric data purgeEnvironmentData

DELETE

Try it out

Path Parameters

organizationId *

envId *

Custom Query Parameters

Custom Headers

Deletes all the data belonging to an environments from Security Fabric Edge

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

envId *: string

The ID of the environment in which the query will be executed

Related Operations:

access-management#listEnvironments.$.data[*].id

Response

Successful. Returns zero length body.

List agent CN and SAN domains listAgentDomains

GET

Try it out

Path Parameters

organizationId *

envId *

agentId *

Custom Query Parameters

Custom Headers

Get all CN (common name) and SANs (Subject Alternate Name) list

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

envId *: string

The ID of the environment in which the query will be executed

Related Operations:

access-management#listEnvironments.$.data[*].id

agentId *: string

The agent ID to identify the target resource.

Response

*/*

Successful operation.

type *: string

domains *: array

Examples

*/*

{ "type": "https", "domains": [ "acme.com", "medical.acme.com", "foo.com" ] }

List environment TLS contexts listTlsContexts

GET

Try it out

Path Parameters

organizationId *

envId *

Custom Query Parameters

Custom Headers

Get TLS contexts configured for the enviorment

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

envId *: string

The ID of the environment in which the query will be executed

Related Operations:

access-management#listEnvironments.$.data[*].id

Response

*/*

Successful operation.

items: array

Array items

Examples

*/*

[ [ { "name": "Test-SecretGroup", "meta": { "id": "fd0e0b7c-8635-4ec4-9902-8a451d8d91a7", "createdAt": "2018-04-27T06:58:38.963000", "modifiedAt": "2018-04-27T06:58:38.963000", "modifiedBy": "kanchan_12345", "locked": false, "lockedBy": null, "currentState": "Clear" } }, [ { "name": "SAN-CN-Test-TLS", "expirationDate": "2019-05-02", "meta": { "id": "5a92ba4c-59ce-4970-908a-ed10e800e3f2", "path": "tlsContexts/5a92ba4c-59ce-4970-908a-ed10e800e3f2" }, "acceptableTlsVersions": { "tlsV1Dot1": false, "tlsV1Dot2": true }, "target": "SecurityFabric", "keystore": { "path": "keystores/191a1c47-be45-4ce1-b381-cf0bbc85fd85", "name": "SAN-CN-Test-Keystore", "details": { "certificate": { "issuer": { "commonName": "testgslab.com", "organizationUnit": "GS", "organizationName": "TEST-GS Lab", "localityName": "PUNE", "state": "MAHARASTRA", "countryName": "IN" }, "subject": { "commonName": "testgslab.com", "organizationUnit": "GS", "organizationName": "TEST-GS Lab", "localityName": "PUNE", "state": "MAHARASTRA", "countryName": "IN" }, "subjectAlternativeName": [ "DNSName:test123.com", "DNSName:gslab4356.com", "DNSName:mysite890.net" ], "version": "3", "serialNumber": "F102B9D8E25A5078", "signatureAlgorithm": "SHA256withRSA", "publicKeyAlgorithm": "RSA", "basicConstraints": null, "validity": { "notBefore": "2018-04-27T07:07:49", "notAfter": "2019-04-27T07:07:49" }, "keyUsage": [ "Digital Signature", "Non Repudiation", "Key Encipherment", "Data Encipherment" ], "extendedKeyUsage": null, "certificateType": "X.509" }, "capath": null } }, "truststore": null, "enableMutualAuthentication": false, "acceptableCipherSuites": { "aes128Sha1": false, "aes256Sha1": false, "camellia128Sha1": false, "camellia256Sha1": false, "desCbc3Sha1": false, "dheDssAes128GcmSha256": false, "dheDssAes128Sha1": false, "dheDssAes128Sha256": false, "dheDssAes256GcmSha384": false, "dheDssAes256Sha1": false, "dheDssAes256Sha256": false, "dheDssCamellia128Sha1": false, "dheDssCamellia256Sha1": false, "dheRsaAes128Sha1": false, "dheRsaAes256Sha1": false, "ecdheEcdsaAes128GcmSha256": true, "ecdheEcdsaAes128Sha1": false, "ecdheEcdsaAes256GcmSha384": false, "ecdheEcdsaAes256Sha1": false, "ecdheEcdsaDesCbc3Sha1": false, "ecdheRsaAes128Sha1": false, "ecdheRsaAes256Sha1": false, "ecdheRsaDesCbc3Sha1": false, "ecdheRsaAes256GcmSha384": true, "ecdheRsaAes128GcmSha256": true, "dheRsaAes256GcmSha384": false, "dheRsaAes128GcmSha256": false, "dheRsaAes256Sha256": false, "dheRsaAes128Sha256": false, "aes256GcmSha384": false, "aes128GcmSha256": false, "aes256Sha256": false, "aes128Sha256": false }, "mutualAuthentication": null } ] ], [ { "name": "Test-SecretGroup-2", "meta": { "id": "703e1b8a-2bba-4baf-aab2-b358d80af71d", "createdAt": "2018-04-23T08:36:32.264000", "modifiedAt": "2018-04-23T08:36:32.264000", "modifiedBy": "kanchan_12345", "locked": false, "lockedBy": null, "currentState": "Clear" } }, [ { "name": "tlscontext1", "expirationDate": "2018-04-30", "meta": { "id": "e4348977-6a4c-49f2-8405-e75543eafa01", "path": "tlsContexts/e4348977-6a4c-49f2-8405-e75543eafa01" }, "acceptableTlsVersions": { "tlsV1Dot1": false, "tlsV1Dot2": true }, "target": "SecurityFabric", "keystore": { "path": "keystores/336993b2-95ea-4f3f-8a19-6031a1ab99f2", "name": "Test-Keystore", "details": { "certificate": { "issuer": { "commonName": "testgslab.com", "organizationUnit": "GS", "organizationName": "TEST-GS Lab", "localityName": "PUNE", "state": "MAHARASTRA", "countryName": "IN" }, "subject": { "commonName": "testgslab.com", "organizationUnit": "GS", "organizationName": "TEST-GS Lab", "localityName": "PUNE", "state": "MAHARASTRA", "countryName": "IN" }, "subjectAlternativeName": [ "DNSName:test123.com", "DNSName:gslab4356.com", "DNSName:mysite890.net" ], "version": "3", "serialNumber": "F102B9D8E25A5078", "signatureAlgorithm": "SHA256withRSA", "publicKeyAlgorithm": "RSA", "basicConstraints": null, "validity": { "notBefore": "2018-04-27T07:07:49", "notAfter": "2019-04-27T07:07:49" }, "keyUsage": [ "Digital Signature", "Non Repudiation", "Key Encipherment", "Data Encipherment" ], "extendedKeyUsage": null, "certificateType": "X.509" }, "capath": null } }, "truststore": { "path": "truststores/076dbd89-3ad9-48a7-a66c-50aa91abe9ed", "name": "truststore1" }, "enableMutualAuthentication": true, "acceptableCipherSuites": { "aes128Sha1": false, "aes256Sha1": false, "camellia128Sha1": false, "camellia256Sha1": false, "desCbc3Sha1": false, "dheDssAes128GcmSha256": false, "dheDssAes128Sha1": false, "dheDssAes128Sha256": false, "dheDssAes256GcmSha384": false, "dheDssAes256Sha1": false, "dheDssAes256Sha256": false, "dheDssCamellia128Sha1": true, "dheDssCamellia256Sha1": true, "dheRsaAes128Sha1": false, "dheRsaAes256Sha1": false, "ecdheEcdsaAes128GcmSha256": true, "ecdheEcdsaAes128Sha1": false, "ecdheEcdsaAes256GcmSha384": false, "ecdheEcdsaAes256Sha1": false, "ecdheEcdsaDesCbc3Sha1": true, "ecdheRsaAes128Sha1": true, "ecdheRsaAes256Sha1": false, "ecdheRsaDesCbc3Sha1": true, "ecdheRsaAes256GcmSha384": true, "ecdheRsaAes128GcmSha256": true, "dheRsaAes256GcmSha384": false, "dheRsaAes128GcmSha256": false, "dheRsaAes256Sha256": false, "dheRsaAes128Sha256": false, "aes256GcmSha384": false, "aes128GcmSha256": false, "aes256Sha256": false, "aes128Sha256": false }, "mutualAuthentication": { "certCheckingStrength": "Lax", "verificationDepth": 1, "performDomainChecking": false, "certificatePolicyChecking": false, "requireInitialExplicitPolicy": false, "certificatePolicies": null, "revocationChecking": false, "revocationCheckingMethod": null, "crlDistributorConfig": null, "requireCrlForAllCa": false, "certificatePinning": { "certificatePinset": null, "performCertificatePinning": false }, "sendTruststore": true, "authenticationOverrides": { "certificateBadFormat": false, "certificateBadSignature": false, "certificateNotYetValid": false, "certificateHasExpired": false, "allowSelfSigned": false, "certificateUnresolved": false, "certificateUntrusted": false, "invalidCa": false, "invalidPurpose": false, "other": false }, "ocspResponderConfig": null } } ] ] ]

List agent virtual servers listAgentVirtualServers

GET

Try it out

Path Parameters

organizationId *

agentId *

Custom Query Parameters

Custom Headers

Get all configured virtual servers for a given agent

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

agentId *: string

The agent ID to identify the target resource.

Response

*/*

Successful operation.

items: array

Array items

Examples

*/*

[ {} ]

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal Server Error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Get agent edge configuration getAgentEdgeConfig

GET

Try it out

Path Parameters

organizationId *

agentId *

Custom Query Parameters

Custom Headers

Get edge configured for the given runtime fabric id

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

agentId *: string

The agent ID to identify the target resource.

Response

Successful operation.

Examples

*/*

{}

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal Server Error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Create agent edge configuration createAgentEdgeConfig

POST

Try it out

Path Parameters

organizationId *

agentId *

Custom Query Parameters

Custom Headers

Request Body application/json

create Edge configuration for the given runtime fabric

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

agentId *: string

The agent ID to identify the target resource.

Request Body

json

Response

Resource created successfully.

Examples

*/*

{}

Bad Request.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unprocessable Entity.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal Server Error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Update agent edge configuration updateAgentEdgeConfig

PUT

Try it out

Path Parameters

organizationId *

agentId *

edgeConfigId *

Custom Query Parameters

Custom Headers

Request Body application/json

Update Edge configuration details for the given edge configurtaion id d

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

agentId *: string

The agent ID to identify the target resource.

edgeConfigId *: string

The edgeConfig ID to identify the target resource.

Related Operations:

anypoint-security-policies#getAgentEdgeConfig.$.id

Request Body

json

Response

Successful operation.

Examples

*/*

{}

Bad Request.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unprocessable Entity.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Patch agent edge configuration patchAgentEdgeConfig

PATCH

Try it out

Path Parameters

organizationId *

agentId *

edgeConfigId *

Custom Query Parameters

Custom Headers

Request Body application/json

Except TLS config, update other configuration if PEM/JKS is selected d

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

agentId *: string

The agent ID to identify the target resource.

edgeConfigId *: string

The edgeConfig ID to identify the target resource.

Related Operations:

anypoint-security-policies#getAgentEdgeConfig.$.id

Request Body

json

capPolicyId: string

The anypoint security policies are getting revamped. This field is going to be deprecated in a future release. If this policy is not used, then this element should not be included.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

advancedOption: object

Controls the gateway connection parameters for the client request

mode: string

This field describes the way edge is configured to run. In 'shared' mode, the internal load balancer runs on the controller nodes. Make sure ports 80 and 443 are open. In 'dedicated' mode, it runs on load balancer nodes.

default: shared

maxConnections *: integer

default: 512, min: 1, max: 1000000

maxRequestPerConnection *: integer

default: 1000, min: 1, max: 4194304

connectionIdleTimeout *: integer

default: 15, min: 1, max: 2592000

requestLifetime *: integer

default: 60, min: 1, max: 14400

startRequestStreamingPayloadSize *: integer

default: 10240, min: 1, max: 1000000

startResponseStreamingPayloadSize *: integer

default: 10240, min: 1, max: 1000000

enableProxyProtocol *: boolean

default: False

readRequestTimeout *: integer

default: 10, min: 1, max: 1200

readResponseTimeout: integer

default: 300, min: 1, max: 3600

writeResponseTimeout: integer

default: 10, min: 1, max: 3600

maxPipelineDepth *: integer

default: 10, min: 1, max: 1000

clientIpAddressFromHttpHeaderName: any

cores *: number

This field is not required for mode type 'dedicated'. If provided with type 'dedicated', this value will be ignored.

default: 0.25, min: 0.25

memory *: number

This field is not required for mode type 'dedicated'. If provided with type 'dedicated', this value will be ignored.

default: 0.5, min: 0.5, max: 4

dosAction: object

DOS commands to log and unblock blocked IPs, this configuration is accepeted only if DOS policy is configured for the Edge

defaultBackEnd: object

Additional configuration to support migration to RTF-C

wafPolicyId: string

The anypoint security policies are getting revamped. This field is going to be deprecated in a future release. If this policy is not used, then this element should not be included.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

httpDomains: array

port: object

port configuration for deployement of edge

virtualServerIds: array

An array of virutal server ids that are configured this agent. To remove an entry from the array skip the entires that you want to remove in update request call.

aclPolicyId: string

The anypoint security policies are getting revamped. This field is going to be deprecated in a future release. If this policy is not used, then this element should not be included.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

logs: object

Log level configuration used by edge for logging

dosPolicyId: string

The anypoint security policies are getting revamped. This field is going to be deprecated in a future release. If this policy is not used, then this element should not be included.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response

Successful operation.

Examples

*/*

{}

Bad Request.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unprocessable Entity.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal Server Error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Delete agent edge configuration deleteAgentEdgeConfig

DELETE

Try it out

Path Parameters

organizationId *

agentId *

edgeConfigId *

Custom Query Parameters

Custom Headers

Delete Edge configuration for the given edge configuration id

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

agentId *: string

The agent ID to identify the target resource.

edgeConfigId *: string

The edgeConfig ID to identify the target resource.

Related Operations:

anypoint-security-policies#getAgentEdgeConfig.$.id

Response

Successful operation.

Examples

*/*

{ "result": "Edge config deleted successfully", "deploymentData": {} }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Get edge deployment status getEdgeDeploymentStatus

GET

Try it out

Path Parameters

organizationId *

agentId *

edgeConfigId *

Custom Query Parameters

Custom Headers

Get the edge deployement status

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

agentId *: string

The agent ID to identify the target resource.

edgeConfigId *: string

The edgeConfig ID to identify the target resource.

Related Operations:

anypoint-security-policies#getAgentEdgeConfig.$.id

Response

*/*

Successful operation.

status *: string

Examples

*/*

{ "status": "APPLYING" }

Not found. The requested resource does not exist.

Examples

*/*

{ "name": "NotFoundError", "status": 404, "message": "Edge Config for the given Runtime Fabric id does not exist", "details": {} }

Bad gateway.

Examples

*/*

{ "message": "Error while trying to get deployment data from deployer", "errors": [] }

List security policies listSecurityPolicies

GET

Try it out

Path Parameters

organizationId *

Query Parameters

type *

Custom Query Parameters

Custom Headers

Get all the policies

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

type *: string

Filter polices based on type. If type does not match return all policies.

Response

*/*

Successful operation.

items: array

Array items

Examples

*/*

[ { "id": "string", "type": "string" } ]

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal Server Error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Create security policy createSecurityPolicy

POST

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Create new policy with type 'DOS (Denial of Service)' or 'CAP (Content Attack Prevention)' or 'ACL(Access Control List)' or 'WAF (Web Application Firewall), SID (Sensitive Information Detection)'

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

Response

*/*

Resource created successfully.

id *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

type *: string

policyData *: any

Examples

*/*

{ "id": { "id": "string", "type": "string" }, "type": "CAP", "policyData": { "id": "string", "type": "string" } }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unprocessable Entity.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal Server Error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Get security policy by ID getSecurityPolicyById

GET

Try it out

Path Parameters

organizationId *

policyId *

Custom Query Parameters

Custom Headers

Get policy using id

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

policyId *: integer

Applied policy instance id on this API instance.

min: 0, max: 2147483647

Related Operations:

anypoint-security-policies#getByOrganizationidPolicies.$[*].id api-manager#listOrganizationsEnvironmentsApisPolicies.$.id api-platform#getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPolicies.$.id cloudhub#getV2ApplicationsByDomainAutoscalepolicies.$.id

Response

*/*

Successful operation.

id *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

type *: string

policyData *: any

Examples

*/*

{ "id": { "id": "string", "type": "string" }, "type": "CAP", "policyData": { "id": "string", "type": "string" } }

Not found. The requested resource does not exist.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Update security policy updateSecurityPolicy

PUT

Try it out

Path Parameters

organizationId *

policyId *

Custom Query Parameters

Custom Headers

Request Body application/json

Update policy by id

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

policyId *: integer

Applied policy instance id on this API instance.

min: 0, max: 2147483647

Related Operations:

anypoint-security-policies#getByOrganizationidPolicies.$[*].id api-manager#listOrganizationsEnvironmentsApisPolicies.$.id api-platform#getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPolicies.$.id cloudhub#getV2ApplicationsByDomainAutoscalepolicies.$.id

Request Body

json

Response

*/*

Successful operation.

id *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

type *: string

policyData *: any

Examples

*/*

{ "id": { "id": "string", "type": "string" }, "type": "CAP", "policyData": { "id": "string", "type": "string" } }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Unprocessable Entity.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Delete security policy deleteSecurityPolicy

DELETE

Try it out

Path Parameters

organizationId *

policyId *

Custom Query Parameters

Custom Headers

Delete policy by id

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

policyId *: integer

Applied policy instance id on this API instance.

min: 0, max: 2147483647

Related Operations:

anypoint-security-policies#getByOrganizationidPolicies.$[*].id api-manager#listOrganizationsEnvironmentsApisPolicies.$.id api-platform#getOrganizationsByOrganizationidApisByApiidVersionsByApiversionidPolicies.$.id cloudhub#getV2ApplicationsByDomainAutoscalepolicies.$.id

Response

*/*

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

*/*

{ "message": "string", "errors": [ { "code": 0, "field": "string", "message": "string" } ] }

Overview

Servers

Authentication & Security

Delete organization Security Fabric data purgeOrganizationData

Try it out

Response

Path Parameters

Response

Delete environment Security Fabric data purgeEnvironmentData

Try it out

Response

Path Parameters

Response

List agent CN and SAN domains listAgentDomains

Try it out

Response

Path Parameters

Response

List environment TLS contexts listTlsContexts

Try it out

Response

Path Parameters

Response

List agent virtual servers listAgentVirtualServers

Try it out

Response

Path Parameters

Response

Get agent edge configuration getAgentEdgeConfig

Try it out

Response

Path Parameters

Response

Create agent edge configuration createAgentEdgeConfig

Try it out

Response

Path Parameters

Request Body

Response

Update agent edge configuration updateAgentEdgeConfig

Try it out

Response

Path Parameters

Request Body

Response

Patch agent edge configuration patchAgentEdgeConfig

Try it out

Response

Path Parameters

Request Body

Response

Delete agent edge configuration deleteAgentEdgeConfig

Try it out

Response

Path Parameters

Response

Get edge deployment status getEdgeDeploymentStatus

Try it out

Response

Path Parameters

Response

List security policies listSecurityPolicies

Try it out

Response

Path Parameters

Query Parameters

Response

Create security policy createSecurityPolicy

Try it out

Response

Path Parameters

Request Body

Response

Get security policy by ID getSecurityPolicyById

Try it out

Response

Path Parameters

Response

Update security policy updateSecurityPolicy