Event Endpoint Management Admin API

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The Admin API provides programmatic access to your Event Endpoint Management deployment and features from other systems.

Base Paths:

• /admin

  • This is the base path for the Admin API URL on the server endpoint, which is also available in the Event Endpoint Management UI.

Authentication

Access control is provided through HTTP bearer authentication by using access tokens. To use the API, create an access token in the Event Endpoint Management UI.

OpenAPI

The OpenAPI specification for this API is available in JSON format. View and download the OpenAPI 3.0.0 specification.

Use this specification with Swagger UI, Postman, or other OpenAPI-compatible tools to explore and test the API endpoints.

Default

createCluster

Code samples

# You can also use wget
curl -X POST /admin/clusters \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /clusters

Create a new cluster.

Body parameter

{
  "bootstrapServers": [
    {
      "host": "string",
      "port": 0,
      "ssl": false,
      "certificates": [
        {
          "pem": "string",
          "subject": "string",
          "sans": [
            "string"
          ],
          "issuer": "string",
          "expiry": 0
        }
      ]
    }
  ],
  "name": "string",
  "lastUpdated": 0,
  "credentials": {
    "type": "NONE",
    "data": {
      "username": "string",
      "password": "string",
      "mechanism": "PLAIN",
      "region": "string",
      "scope": "string",
      "audience": "string",
      "oauthTokenUri": "string",
      "trustedCertificates": [
        {
          "pem": "string",
          "subject": "string",
          "sans": [
            "string"
          ],
          "issuer": "string",
          "expiry": 0
        }
      ],
      "clientCertificateAndKey": {
        "pem": "string",
        "key": "string",
        "expiry": 0
      }
    }
  },
  "collaborators": {
    "groups": [
      "string"
    ]
  }
}

Parameters

Name	In	Type	Required	Description
disableValidation	query	boolean	false	Disable immediate validation against the remote server.
body	body	object	true	none
» bootstrapServers	body	[object]	true	Bootstrap servers for this cluster.
»» host	body	string	true	Kafka server host name.
»» port	body	integer	true	Kafka server port.
»» ssl	body	boolean	false	Connect over SSL.
»» certificates	body	[object]	false	Certificates or CAs to trust, required to connect to the server via SSL.
»»» pem	body	string	true	Certificate in PEM format
»»» subject	body	string	false	Subject name of the certificate
»»» sans	body	[string]	false	A list of subject alternative names of the certificate
»»» issuer	body	string	false	Issuer of the certificate
»»» expiry	body	integer	false	Expiration date of the certificate in epoch millis
» name	body	string	true	Cluster name.
» lastUpdated	body	integer	false	Time in ms since the epoch which represents the last time the cluster information was updated.
» credentials	body	object	false	Credentials to be used by the gateway to connect to Kafka.
»» type	body	string	true	The type of credentials.
»» data	body	object	true	Details of the SASL credential data to authenticate with Kafka.
»»» username	body	string	false	SASL username to authenticate with Kafka.
»»» password	body	string	false	SASL password to authenticate with Kafka.
»»» mechanism	body	string	false	SASL mechanism to authenticate with Kafka.
»»» region	body	string	false	Optional field containing the AWS MSK Region.
»»» scope	body	string	false	Optional field containing the scope for requesting the token from the token endpoint.
»»» audience	body	string	false	Optional field containing the audience for requesting the token from the token endpoint.
»»» oauthTokenUri	body	string	false	Optional URI of the OAuth token endpoint.
»»» trustedCertificates	body	[object]	false	Certificates or CAs to trust. Required to connect to OAuth server.
»»»» pem	body	string	true	Certificate in PEM format
»»»» subject	body	string	false	Subject name of the certificate
»»»» sans	body	[string]	false	A list of subject alternative names of the certificate
»»»» issuer	body	string	false	Issuer of the certificate
»»»» expiry	body	integer	false	Expiration date of the certificate in epoch millis
»»» clientCertificateAndKey	body	object	false	Client certificate and key to use in mTLS
»»»» pem	body	string	true	Client certificate in PEM format
»»»» key	body	string	true	Client key in PEM format
»»»» expiry	body	integer	false	Expiration date of the certificate in epoch millis
» collaborators	body	object	false	none
»» groups	body	[string]	true	List of collaborators for this cluster.

Enumerated Values

Parameter	Value
»» type	NONE
»» type	SASL
»» type	MTLS
»» type	MTLS_SASL
»»» mechanism	PLAIN
»»» mechanism	SCRAM-SHA-256
»»» mechanism	SCRAM-SHA-512
»»» mechanism	OAUTHBEARER
»»» mechanism	OAUTHBEARER.AWS_MSK_IAM

Example responses

200 Response

{
  "id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Cluster successfully created.	Inline
400	Bad Request	Bad input.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
409	Conflict	A cluster with the specified ID or name already exists.	None
422	Unprocessable Entity	The specified cluster could not be validated by using Kafka discovery mechanisms. For example, connection fails, certs mis-matched, SASL mis-match.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	false	none	The ID of your newly created cluster.

readAllClusters

Code samples

# You can also use wget
curl -X GET /admin/clusters \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /clusters

List all clusters within an organization.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The page number of results to retrieve. If this number exceeds the available data, then the last page is returned.
maxPageSize	query	integer	false	The maximum number of entries to return per page. If not specified, all data items are returned.

Example responses

200 Response

[
  {
    "bootstrapServers": [
      {
        "host": "string",
        "port": 0,
        "ssl": false,
        "certificates": [
          {
            "pem": "string",
            "subject": "string",
            "sans": [
              "string"
            ],
            "issuer": "string",
            "expiry": 0
          }
        ]
      }
    ],
    "id": "string",
    "name": "string",
    "owner": "string",
    "organization": "string",
    "lastUpdated": 0,
    "credentials": {
      "type": "NONE",
      "data": {
        "username": "string",
        "mechanism": "PLAIN",
        "region": "string",
        "scope": "string",
        "audience": "string",
        "oauthTokenUri": "string",
        "trustedCertificates": [
          {
            "pem": "string",
            "subject": "string",
            "sans": [
              "string"
            ],
            "issuer": "string",
            "expiry": 0
          }
        ],
        "clientCertificateAndKey": {
          "pem": "string",
          "expiry": 0
        }
      }
    },
    "collaborators": {
      "groups": [
        "string"
      ]
    },
    "validation": {
      "status": "pending",
      "gatewayGroups": [
        {
          "name": "string",
          "status": "pending",
          "gateways": [
            {
              "id": "string",
              "validationErrors": [
                "network"
              ]
            }
          ]
        }
      ]
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Clusters successfully listed.	Inline
304	Not Modified	Data not changed.	None
400	Bad Request	Invalid request, only one of page and maxPageSize were supplied or max page size exceeded.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» bootstrapServers	[object]	false	none	Bootstrap servers for this cluster - only viewable with permissions.
»» host	string	true	none	Kafka server host name.
»» port	integer	true	none	Kafka server port.
»» ssl	boolean	false	none	Connect over SSL.
»» certificates	[object]	false	none	Certificates or CAs to trust, required to connect to the server via SSL.
»»» pem	string	true	none	Certificate in PEM format
»»» subject	string	false	none	Subject name of the certificate
»»» sans	[string]	false	none	A list of subject alternative names of the certificate
»»» issuer	string	false	none	Issuer of the certificate
»»» expiry	integer	false	none	Expiration date of the certificate in epoch millis
» id	string	true	none	Unique cluster ID.
» name	string	true	none	Cluster name.
» owner	string	true	none	Cluster owner.
» organization	string	true	none	Organization this cluster belongs to.
» lastUpdated	integer	false	none	Time in ms since the epoch which represents the last time the cluster information was updated.
» credentials	object	false	none	Credentials to be used by the gateway to connect to Kafka.
»» type	string	true	none	The type of credentials. Used by parsers to determine how to handle the other fields.
»» data	object	true	none	Details of the SASL credential data to authenticate with Kafka.
»»» username	string	false	none	SASL username to authenticate with Kafka.
»»» mechanism	string	false	none	SASL mechanism to authenticate with Kafka.
»»» region	string	false	none	Optional field containing the AWS MSK Region.
»»» scope	string	false	none	Optional field containing the scope for requesting the token from the token endpoint.
»»» audience	string	false	none	Optional field containing the audience for requesting the token from the token endpoint.
»»» oauthTokenUri	string	false	none	Optional URI of the OAuth token endpoint.
»»» trustedCertificates	[object]	false	none	Certificates or CAs to trust, required to connect to OAuth server.
»»»» pem	string	true	none	Certificate in PEM format
»»»» subject	string	false	none	Subject name of the certificate
»»»» sans	[string]	false	none	A list of subject alternative names of the certificate
»»»» issuer	string	false	none	Issuer of the certificate
»»»» expiry	integer	false	none	Expiration date of the certificate in epoch millis
»»» clientCertificateAndKey	object	false	none	Client certificate and key to use in mTLS
»»»» pem	string	true	none	Client certificate in PEM format
»»»» expiry	integer	false	none	Expiration date of the certificate in epoch millis
» collaborators	object	true	none	none
»» groups	[string]	true	none	List of collaborators for this cluster.
» validation	object	true	none	Details of the visibility of this cluster amongst the gateways.
»» status	string	true	none	Overall status of all of the gateways.
»» gatewayGroups	[object]	true	none	Gateway group names and if they can connect to this cluster.
»»» name	string	true	none	none
»»» status	string	true	none	Status on whether this gateway group can access the associated cluster.
»»» gateways	[object]	true	none	none
»»»» id	string	true	none	none
»»»» validationErrors	[string]	true	none	List of failed validation stages. If this array is empty, then this gateway group can access the cluster.

Enumerated Values

Property	Value
type	NONE
type	SASL
type	MTLS
type	MTLS_SASL
mechanism	PLAIN
mechanism	SCRAM-SHA-256
mechanism	SCRAM-SHA-512
mechanism	OAUTHBEARER
mechanism	OAUTHBEARER.AWS_MSK_IAM
status	pending
status	error
status	success/partial
status	success
status	pending
status	error
status	success/partial
status	success

Response Headers

Status	Header	Type	Format	Description
200	ei-pagination-total	integer		Total number of items available for retrieval (including current page).
200	etag	string		An identifier that can be supplied with the If-None-Match header to indicate that unchanged results should return 304 with no data.

updateCluster

Code samples

# You can also use wget
curl -X PUT /admin/clusters/{clusterId} \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT /clusters/{clusterId}

Update a cluster. Use the ID as the identifier.

Note - You can view all of the clusters (including their ID) by using GET /clusters

Body parameter

{
  "bootstrapServers": [
    {
      "host": "string",
      "port": 0,
      "ssl": false,
      "certificates": [
        {
          "pem": "string",
          "subject": "string",
          "sans": [
            "string"
          ],
          "issuer": "string",
          "expiry": 0
        }
      ]
    }
  ],
  "name": "string",
  "lastUpdated": 0,
  "credentials": {
    "type": "NONE",
    "data": {
      "username": "string",
      "password": "string",
      "mechanism": "PLAIN",
      "region": "string",
      "scope": "string",
      "audience": "string",
      "oauthTokenUri": "string",
      "trustedCertificates": [
        {
          "pem": "string",
          "subject": "string",
          "sans": [
            "string"
          ],
          "issuer": "string",
          "expiry": 0
        }
      ],
      "clientCertificateAndKey": {
        "pem": "string",
        "key": "string",
        "expiry": 0
      }
    }
  },
  "collaborators": {
    "groups": [
      "string"
    ]
  }
}

Parameters

Name	In	Type	Required	Description
clusterId	path	string	true	The ID of the cluster.
disableValidation	query	boolean	false	Disable immediate validation against the remote server.
body	body	object	true	Update a cluster definition.
» bootstrapServers	body	[object]	true	Bootstrap servers for this cluster.
»» host	body	string	true	Kafka server host name.
»» port	body	integer	true	Kafka server port.
»» ssl	body	boolean	false	Connect over SSL.
»» certificates	body	[object]	false	Certificates or CAs to trust, required to connect to the server via SSL.
»»» pem	body	string	true	Certificate in PEM format
»»» subject	body	string	false	Subject name of the certificate
»»» sans	body	[string]	false	A list of subject alternative names of the certificate
»»» issuer	body	string	false	Issuer of the certificate
»»» expiry	body	integer	false	Expiration date of the certificate in epoch millis
» name	body	string	true	Cluster name.
» lastUpdated	body	integer	false	Time in ms since the epoch which represents the last time the cluster information was updated.
» credentials	body	object	false	Credentials to be used by the gateway to connect to Kafka.
»» type	body	string	true	The type of credentials.
»» data	body	object	true	Details of the SASL credential data to authenticate with Kafka.
»»» username	body	string	false	SASL username to authenticate with Kafka.
»»» password	body	string	false	SASL password to authenticate with Kafka.
»»» mechanism	body	string	false	SASL mechanism to authenticate with Kafka.
»»» region	body	string	false	Optional field containing the AWS MSK Region.
»»» scope	body	string	false	Optional field containing the scope for requesting the token from the token endpoint.
»»» audience	body	string	false	Optional field containing the audience for requesting the token from the token endpoint.
»»» oauthTokenUri	body	string	false	Optional URI of the OAuth token endpoint.
»»» trustedCertificates	body	[object]	false	Certificates or CAs to trust. Required to connect to OAuth server.
»»»» pem	body	string	true	Certificate in PEM format
»»»» subject	body	string	false	Subject name of the certificate
»»»» sans	body	[string]	false	A list of subject alternative names of the certificate
»»»» issuer	body	string	false	Issuer of the certificate
»»»» expiry	body	integer	false	Expiration date of the certificate in epoch millis
»»» clientCertificateAndKey	body	object	false	Client certificate and key to use in mTLS
»»»» pem	body	string	true	Client certificate in PEM format
»»»» key	body	string	true	Client key in PEM format
»»»» expiry	body	integer	false	Expiration date of the certificate in epoch millis
» collaborators	body	object	false	none
»» groups	body	[string]	true	List of collaborators for this cluster.

Enumerated Values

Parameter	Value
»» type	NONE
»» type	SASL
»» type	MTLS
»» type	MTLS_SASL
»»» mechanism	PLAIN
»»» mechanism	SCRAM-SHA-256
»»» mechanism	SCRAM-SHA-512
»»» mechanism	OAUTHBEARER
»»» mechanism	OAUTHBEARER.AWS_MSK_IAM

Responses

Status	Meaning	Description	Schema
200	OK	Cluster updated.	None
400	Bad Request	Bad input.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	Cluster not found.	None
409	Conflict	Cluster with the specified name already exists.	None
422	Unprocessable Entity	The specified cluster could not be validated using Kafka discovery mechanisms. For example, connection fails, certs mis-matched, SASL mis-match.	None
500	Internal Server Error	Internal error.	None

readCluster

Code samples

# You can also use wget
curl -X GET /admin/clusters/{clusterId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /clusters/{clusterId}

Get details about a cluster.

Parameters

Name	In	Type	Required	Description
clusterId	path	string	true	The ID of the cluster.

Example responses

200 Response

{
  "bootstrapServers": [
    {
      "host": "string",
      "port": 0,
      "ssl": false,
      "certificates": [
        {
          "pem": "string",
          "subject": "string",
          "sans": [
            "string"
          ],
          "issuer": "string",
          "expiry": 0
        }
      ]
    }
  ],
  "id": "string",
  "name": "string",
  "owner": "string",
  "organization": "string",
  "lastUpdated": 0,
  "credentials": {
    "type": "NONE",
    "data": {
      "username": "string",
      "mechanism": "PLAIN",
      "region": "string",
      "scope": "string",
      "audience": "string",
      "oauthTokenUri": "string",
      "trustedCertificates": [
        {
          "pem": "string",
          "subject": "string",
          "sans": [
            "string"
          ],
          "issuer": "string",
          "expiry": 0
        }
      ],
      "clientCertificateAndKey": {
        "pem": "string",
        "expiry": 0
      }
    }
  },
  "collaborators": {
    "groups": [
      "string"
    ]
  },
  "validation": {
    "status": "pending",
    "gatewayGroups": [
      {
        "name": "string",
        "status": "pending",
        "gateways": [
          {
            "id": "string",
            "validationErrors": [
              "network"
            ]
          }
        ]
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Cluster successfully read.	Inline
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	Cluster not found.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» bootstrapServers	[object]	false	none	Bootstrap servers for this cluster - only viewable with permissions.
»» host	string	true	none	Kafka server host name.
»» port	integer	true	none	Kafka server port.
»» ssl	boolean	false	none	Connect over SSL.
»» certificates	[object]	false	none	Certificates or CAs to trust, required to connect to the server via SSL.
»»» pem	string	true	none	Certificate in PEM format
»»» subject	string	false	none	Subject name of the certificate
»»» sans	[string]	false	none	A list of subject alternative names of the certificate
»»» issuer	string	false	none	Issuer of the certificate
»»» expiry	integer	false	none	Expiration date of the certificate in epoch millis
» id	string	true	none	Unique cluster ID.
» name	string	true	none	Cluster name.
» owner	string	true	none	Cluster owner.
» organization	string	true	none	Organization this cluster belongs to.
» lastUpdated	integer	false	none	Time in ms since the epoch which represents the last time the cluster information was updated.
» credentials	object	false	none	Credentials to be used by the gateway to connect to Kafka.
»» type	string	true	none	The type of credentials. Used by parsers to determine how to handle the other fields.
»» data	object	true	none	Details of the SASL credential data to authenticate with Kafka.
»»» username	string	false	none	SASL username to authenticate with Kafka.
»»» mechanism	string	false	none	SASL mechanism to authenticate with Kafka.
»»» region	string	false	none	Optional field containing the AWS MSK Region.
»»» scope	string	false	none	Optional field containing the scope for requesting the token from the token endpoint.
»»» audience	string	false	none	Optional field containing the audience for requesting the token from the token endpoint.
»»» oauthTokenUri	string	false	none	Optional URI of the OAuth token endpoint.
»»» trustedCertificates	[object]	false	none	Certificates or CAs to trust, required to connect to OAuth server.
»»»» pem	string	true	none	Certificate in PEM format
»»»» subject	string	false	none	Subject name of the certificate
»»»» sans	[string]	false	none	A list of subject alternative names of the certificate
»»»» issuer	string	false	none	Issuer of the certificate
»»»» expiry	integer	false	none	Expiration date of the certificate in epoch millis
»»» clientCertificateAndKey	object	false	none	Client certificate and key to use in mTLS
»»»» pem	string	true	none	Client certificate in PEM format
»»»» expiry	integer	false	none	Expiration date of the certificate in epoch millis
» collaborators	object	true	none	none
»» groups	[string]	true	none	List of collaborators for this cluster.
» validation	object	true	none	Details of the visibility of this cluster amongst the gateways.
»» status	string	true	none	Overall status of all of the gateways.
»» gatewayGroups	[object]	true	none	Gateway group names and if they can connect to this cluster.
»»» name	string	true	none	none
»»» status	string	true	none	Status on whether this gateway group can access the associated cluster.
»»» gateways	[object]	true	none	none
»»»» id	string	true	none	none
»»»» validationErrors	[string]	true	none	List of failed validation stages. If this array is empty, then this gateway group can access the cluster.

Enumerated Values

Property	Value
type	NONE
type	SASL
type	MTLS
type	MTLS_SASL
mechanism	PLAIN
mechanism	SCRAM-SHA-256
mechanism	SCRAM-SHA-512
mechanism	OAUTHBEARER
mechanism	OAUTHBEARER.AWS_MSK_IAM
status	pending
status	error
status	success/partial
status	success
status	pending
status	error
status	success/partial
status	success

deleteCluster

Code samples

# You can also use wget
curl -X DELETE /admin/clusters/{clusterId} \
  -H 'Authorization: Bearer {access-token}'

DELETE /clusters/{clusterId}

Delete a cluster.

All related catalog entries must be deleted before you delete a cluster. Note - You must be the owner to delete a cluster. You can view all of the clusters that you own (including their ID) by using GET /clusters

Parameters

Name	In	Type	Required	Description
clusterId	path	string	true	The ID of the cluster.

Responses

Status	Meaning	Description	Schema
200	OK	Cluster successfully deleted.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	Cluster not found.	None
409	Conflict	Catalog entries are still using this cluster and it cannot be deleted.	None
500	Internal Server Error	Internal error.	None

createSubscription

Code samples

# You can also use wget
curl -X POST /admin/subscriptions \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /subscriptions

Create a subscription to a catalog entry. This endpoint is now deprecated. Use /applications/{applicationId}/subscriptions endpoint instead.

Body parameter

{
  "entryId": [
    "string"
  ],
  "credentials": {
    "type": "NONE",
    "data": {
      "username": "string",
      "password": "string",
      "mechanism": "PLAIN",
      "hashedPasswords": [
        "string"
      ],
      "subjectCommonName": "string",
      "subjectOrganization": "string",
      "subjectCountry": "string",
      "subjectStateOrProvince": "string",
      "subjectLocality": "string"
    }
  },
  "clientId": "string",
  "contact": "string",
  "gateways": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» entryId	body	[string]	true	The list of entry IDs this subscription gives access to. Currently only supports 1.
» credentials	body	object	true	Credentials a client uses to connect to an event gateway.
»» type	body	string	true	The type of credentials.
»» data	body	object	true	Details of the SASL credential data to authenticate with an event gateway.
»»» username	body	string	false	SASL username to authenticate with an event gateway.
»»» password	body	string	false	SASL password to authenticate with an event gateway.
»»» mechanism	body	string	false	SASL mechanism to authenticate with Kafka.
»»» hashedPasswords	body	[string]	false	Hashed passwords from APIC to authenticate clients against an event gateway.
»»» subjectCommonName	body	string	false	Subject Common Name to match on.
»»» subjectOrganization	body	string	false	Subject Organization to match on.
»»» subjectCountry	body	string	false	Subject Country to match on.
»»» subjectStateOrProvince	body	string	false	Subject Region to match on.
»»» subjectLocality	body	string	false	Subject Locality to match on.
» clientId	body	string	false	Optional client ID if this subscription is a legacy API Connect subscription.
» contact	body	string	true	Subscription contact details.
» gateways	body	[string]	false	A list of gateway IDs that can access this data. If this property is missing or contains an empty list then this subscription has no gateway restrictions.

Enumerated Values

Parameter	Value
»» type	NONE
»» type	SASL
»» type	SASL_APIC
»» type	MTLS
»»» mechanism	PLAIN
»»» mechanism	OAUTHBEARER

Example responses

200 Response

{
  "id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Subscription successfully created.	Inline
400	Bad Request	Bad input.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
409	Conflict	Subscription with the specified ID already exists.	None
422	Unprocessable Entity	Subscription to invalid topic.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	false	none	The ID of your newly created subscription.

readAllSubscriptions

Code samples

# You can also use wget
curl -X GET /admin/subscriptions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /subscriptions

List all subscriptions created by the current user in an organization. This endpoint is now deprecated. Use /applications endpoint instead.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The page number of results to retrieve. If this number exceeds the available data, then the last page is returned.
maxPageSize	query	integer	false	The maximum number of entries to return per page. If not specified, all data items are returned.

Example responses

200 Response

[
  {
    "id": "string",
    "owner": "string",
    "entryId": [
      "string"
    ],
    "organization": "string",
    "credentials": {
      "type": "NONE",
      "data": {
        "username": "string",
        "mechanism": "PLAIN",
        "subjectCommonName": "string",
        "subjectOrganization": "string",
        "subjectCountry": "string",
        "subjectStateOrProvince": "string",
        "subjectLocality": "string"
      }
    },
    "clientId": "string",
    "contact": "string",
    "gateways": [
      "string"
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Subscriptions are successfully listed.	Inline
304	Not Modified	Data not changed.	None
400	Bad Request	Invalid request, only one of page and maxPageSize were supplied or max page size exceeded.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique subscription ID.
» owner	string	true	none	Subscription owner.
» entryId	[string]	true	none	The list of entry IDs this subscription gives access to. Currently only supports 1.
» organization	string	true	none	Organization this subscription belongs to.
» credentials	object	false	none	Credentials a client uses to connect to an event gateway.
»» type	string	true	none	The type of credentials. Used by parsers to determine how to handle the other fields.
»» data	object	true	none	Details of the SASL credential data to authenticate with an event gateway.
»»» username	string	false	none	SASL username to authenticate with an event gateway.
»»» mechanism	string	false	none	SASL mechanism to authenticate with Kafka.
»»» subjectCommonName	string	false	none	Subject Common Name to match on.
»»» subjectOrganization	string	false	none	Subject Organization to match on.
»»» subjectCountry	string	false	none	Subject Country to match on.
»»» subjectStateOrProvince	string	false	none	Subject Region to match on.
»»» subjectLocality	string	false	none	Subject Locality to match on.
» clientId	string	false	none	Optional client ID if this subscription is a legacy API Connect subscription.
» contact	string	true	none	Subscription contact details.
» gateways	[string]	false	none	A list of gateway IDs that can access this data. If this property is missing or contains an empty list then this subscription has no gateway restrictions.

Enumerated Values

Property	Value
type	NONE
type	SASL
type	SASL_APIC
type	MTLS
mechanism	PLAIN
mechanism	OAUTHBEARER

Response Headers

Status	Header	Type	Format	Description
200	ei-pagination-total	integer		Total number of items available for retrieval (including current page).
200	etag	string		An identifier that can be supplied with the If-None-Match header to indicate that unchanged results should return 304 with no data.

deleteSubscription

Code samples

# You can also use wget
curl -X DELETE /admin/subscriptions/{subscriptionId} \
  -H 'Authorization: Bearer {access-token}'

DELETE /subscriptions/{subscriptionId}

Delete a subscription. This endpoint is now deprecated. Use /applications/{applicationId}/subscription/${virtualTopicId} endpoint instead.

Parameters

Name	In	Type	Required	Description
subscriptionId	path	string	true	The ID of the subscription.

Responses

Status	Meaning	Description	Schema
200	OK	Subscription successfully deleted.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	Subscription not found.	None
500	Internal Server Error	Internal error.	None

createGateway

Code samples

# You can also use wget
curl -X POST /admin/gateways \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /gateways

Create an event gateway instance.

Body parameter

{
  "gatewayGroup": "string",
  "gatewayId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» gatewayGroup	body	string	true	The required gateway group. If the specified group does not exist, then it is created.
» gatewayId	body	string	true	The ID of the gateway. The ID must be unique within the gateway group.

Example responses

200 Response

{
  "apiKey": "string",
  "name": "string",
  "managerClientUrl": "string",
  "managerClientCACertificates": "string",
  "licenceKey": "string",
  "imageUrl": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Event gateway created with the Event Manager.	Inline
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
426	Upgrade Required	Limit reached, upgrade required to your service plan.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Returns values to deploy a gateway.

Name	Type	Required	Restrictions	Description
» apiKey	string	true	none	The API key for the event gateway.
» name	string	false	none	The name for the event gateway.
» managerClientUrl	string	false	none	The secure backend gateway registration endpoint.
» managerClientCACertificates	string	false	none	The inlined CA certificates required for the secure gateway registration endpoint.
» licenceKey	string	false	none	The license that the gateway should be running under.
» imageUrl	string	false	none	The url of the gateway container image.

readAllGateways

Code samples

# You can also use wget
curl -X GET /admin/gateways \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /gateways

List all registered event gateways in an organization.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The page number of results to retrieve. If this number exceeds the available data, then the last page is returned.
maxPageSize	query	integer	false	The maximum number of entries to return per page. If not specified, all data items are returned.

Example responses

200 Response

[
  {
    "name": "string",
    "gateways": [
      {
        "id": "string",
        "owner": "string",
        "organization": "string",
        "gatewayId": "string",
        "group": "string",
        "organizations": [
          "string"
        ],
        "servedOrganizations": [
          "string"
        ],
        "contact": "string",
        "lastContact": 0,
        "endpoints": [
          {
            "host": "string",
            "port": 0,
            "ssl": false,
            "certificates": [
              {
                "pem": "string",
                "subject": "string",
                "sans": [
                  "string"
                ],
                "issuer": "string",
                "expiry": 0
              }
            ]
          }
        ],
        "version": "string",
        "productVersion": "string",
        "features": [
          "string"
        ],
        "deploymentMode": "string",
        "capabilities": {}
      }
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Event gateways successfully listed.	Inline
304	Not Modified	Data not changed.	None
400	Bad Request	Invalid request, only one of page and maxPageSize were supplied or max page size exceeded.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» name	string	true	none	Unique gateway group name.
» gateways	[object]	true	none	none
»» id	string	true	none	Unique event gateway ID.
»» owner	string	true	none	Owner of the event gateway.
»» organization	string	true	none	Organization this event gateway belongs to.
»» gatewayId	string	true	none	Unique event gateway ID within this group.
»» group	string	true	none	Event gateway group name.
»» organizations	[string]	true	none	Organizations this event gateway serves.
»» servedOrganizations	[string]	true	none	Organizations this event gateway serves.
»» contact	string	false	none	The contact information for this event gateway.
»» lastContact	integer	true	none	Epoch time in ms of the last contact from this gateway.
»» endpoints	[object]	true	none	Endpoints that the gateway is listening on.
»»» host	string	true	none	Kafka server host name.
»»» port	integer	true	none	Kafka server port.
»»» ssl	boolean	false	none	Connect over SSL.
»»» certificates	[object]	false	none	Certificates or CAs to trust, required to connect to the server via SSL.
»»»» pem	string	true	none	Certificate in PEM format
»»»» subject	string	false	none	Subject name of the certificate
»»»» sans	[string]	false	none	A list of subject alternative names of the certificate
»»»» issuer	string	false	none	Issuer of the certificate
»»»» expiry	integer	false	none	Expiration date of the certificate in epoch millis
»» version	string	false	none	Version of the gateway.
»» productVersion	string	false	none	EEM product version.
»» features	[string]	false	none	Feature set in use by gateway.
»» deploymentMode	string	false	none	Type of gateway deployment.
»» capabilities	object	false	none	Description of what capabilities the gateway has.

Response Headers

Status	Header	Type	Format	Description
200	ei-pagination-total	integer		Total number of items available for retrieval (including current page).
200	etag	string		An identifier that can be supplied with the If-None-Match header to indicate that unchanged results should return 304 with no data.

deleteGateway

Code samples

# You can also use wget
curl -X DELETE /admin/gateways/{gatewayGroup}/{gatewayId} \
  -H 'Authorization: Bearer {access-token}'

DELETE /gateways/{gatewayGroup}/{gatewayId}

Delete an existing event gateway registration.

Parameters

Name	In	Type	Required	Description
gatewayGroup	path	string	true	Event gateway group name.
gatewayId	path	string	true	ID for an event gateway instance.

Responses

Status	Meaning	Description	Schema
200	OK	Event gateway deleted successfully.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	No event gateway found with this group and ID.	None
409	Conflict	Event gateway is not deleted due to virtual topics published or archived on the event gateway group.	None
500	Internal Server Error	Internal error.	None

readAllEventSources

Code samples

# You can also use wget
curl -X GET /admin/eventsources \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /eventsources

List all source topics created by the current user in an organization.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The page number of results to retrieve. If this number exceeds the available data, then the last page is returned.
maxPageSize	query	integer	false	The maximum number of entries to return per page. If not specified, all data items are returned.
filterBy	query	string	false	Capability to filter by.

Enumerated Values

Parameter	Value
filterBy	consume
filterBy	produce

Example responses

200 Response

[
  {
    "id": "string",
    "owner": "string",
    "organization": "string",
    "clusterId": "string",
    "type": "kafka",
    "encoding": "unknown",
    "name": "string",
    "contact": "string",
    "description": "string",
    "topic": {
      "name": "string",
      "partitions": 0,
      "replicas": 0,
      "uuid": "string"
    },
    "schema": {
      "type": "avro",
      "content": "string",
      "description": "string"
    },
    "tags": [
      "string"
    ],
    "sampleMessages": [
      "string"
    ],
    "capabilities": [
      "consume"
    ],
    "validation": {
      "status": "pending",
      "gatewayGroups": [
        {
          "name": "string",
          "status": "pending",
          "gateways": [
            {
              "id": "string",
              "validationErrors": [
                "notFound"
              ]
            }
          ]
        }
      ]
    },
    "collaborators": {
      "groups": [
        "string"
      ],
      "contacts": [
        "string"
      ]
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Source topics successfully listed.	Inline
304	Not Modified	Data not changed.	None
400	Bad Request	Invalid request, only one of page and maxPageSize were supplied or max page size exceeded.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique source topic ID.
» owner	string	true	none	Source topic owner.
» organization	string	true	none	Organization that this source topic belongs to.
» clusterId	string	true	none	ID for the cluster that contains the connection details for this source topic.
» type	string	true	none	Type of source topic.
» encoding	string	true	none	The encoding of the data on this source topic.
» name	string	true	none	Source topic name.
» contact	string	true	none	Who to contact for more information about this source topic.
» description	string	false	none	A description for this source topic.
» topic	object	false	none	none
»» name	string	true	none	Actual topic name in the cluster.
»» partitions	number	false	none	The number of partitions for this topic. Discovered from the Kafka cluster.
»» replicas	number	false	none	The number of replicas for this topic. Discovered from the Kafka cluster.
»» uuid	string	false	none	The UUID of the topic. Discovered from the Kafka cluster.
» schema	object	false	none	none
»» type	string	false	none	Type of schema from the list of valid types.
»» content	string	false	none	Contents of the schema.
»» description	string	false	none	Description of the data available on the source topic.
» tags	[string]	false	none	List of tags associated with this source topic.
» sampleMessages	[string]	false	none	none
» capabilities	[string]	true	none	none
» validation	object	false	none	Details of the visibility of this source topic amongst the gateway groups.
»» status	string	true	none	Status for all of the gateway groups. Can they see the topic associated with this source topic?
»» gatewayGroups	[object]	true	none	Gateway group names and if they can connect to this cluster and find the associated topic.
»»» name	string	true	none	none
»»» status	string	true	none	Status on whether this gateway group can see the topic associated with this source topic.
»»» gateways	[object]	true	none	none
»»»» id	string	true	none	none
»»»» validationErrors	[string]	true	none	List of failed validation stages. If this array is empty, then gateway group can access the topic.
» collaborators	object	true	none	none
»» groups	[string]	true	none	List of collaborators for this source topic.
»» contacts	[string]	true	none	List of contacts for this source topic.

Enumerated Values

Property	Value
type	kafka
encoding	unknown
encoding	text/plain
encoding	application/octet-stream
encoding	application/json
encoding	avro/binary
encoding	avro/json
type	avro
type	json
type	unknown
status	pending
status	error
status	success/partial
status	success
status	pending
status	error
status	success/partial
status	success

Response Headers

Status	Header	Type	Format	Description
200	ei-pagination-total	integer		Total number of items available for retrieval (including current page).
200	etag	string		An identifier that can be supplied with the If-None-Match header to indicate that unchanged results should return 304 with no data.

createEventSource

Code samples

# You can also use wget
curl -X POST /admin/eventsources \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /eventsources

Create a source topic.

Body parameter

{
  "clusterId": "string",
  "type": "kafka",
  "encoding": "unknown",
  "name": "string",
  "contact": "string",
  "description": "string",
  "topic": {
    "name": "string",
    "partitions": 0,
    "replicas": 0,
    "uuid": "stringstringstringst"
  },
  "schema": {
    "type": "avro",
    "content": "string",
    "description": "string"
  },
  "tags": [
    "string"
  ],
  "sampleMessages": [
    "string"
  ],
  "capabilities": [
    "consume"
  ],
  "collaborators": {
    "groups": [
      "string"
    ],
    "contacts": [
      "string"
    ]
  }
}

Parameters

Name	In	Type	Required	Description
disableValidation	query	boolean	false	Disable immediate validation against the remote server.
body	body	object	true	Source topic data.
» clusterId	body	string	true	ID for the cluster that contains the connection details for this source topic.
» type	body	string	true	Type of source topic.
» encoding	body	string	true	The encoding of the data on this source topic.
» name	body	string	true	Source topic name.
» contact	body	string	true	Who to contact for more information about this source topic.
» description	body	string	false	A description for this source topic.
» topic	body	object	false	none
»» name	body	string	true	Actual topic name in the cluster.
»» partitions	body	number	false	The number of partitions for this topic, updated by discovery.
»» replicas	body	number	false	The number of replicas for this topic, updated by discovery.
»» uuid	body	string	false	The UUID of the topic, updated by discovery.
» schema	body	object	false	none
»» type	body	string	false	Type of schema from the list of valid types.
»» content	body	string	false	Contents of the schema.
»» description	body	string	false	Description of the data available on the source topic.
»» anonymous	body	object	false	none
»» anonymous	body	object	false	none
» tags	body	[string]	false	List of tags associated with this source topic.
» sampleMessages	body	[string]	false	none
» capabilities	body	[string]	false	none
» collaborators	body	object	false	none
»» groups	body	[string]	true	List of collaborators for this source topic.
»» contacts	body	[string]	true	List of contacts for this source topic.

Enumerated Values

Parameter	Value
» type	kafka
» encoding	unknown
» encoding	text/plain
» encoding	application/octet-stream
» encoding	application/json
» encoding	avro/binary
» encoding	avro/json
»» type	avro
»» type	json
»» type	unknown
» capabilities	consume
» capabilities	produce

Example responses

200 Response

{
  "id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The ID of the created source topic.	Inline
400	Bad Request	Invalid request, request data does not match the schema.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
409	Conflict	Source topic could not be created due to a conflict.	None
422	Unprocessable Entity	Source topic could not be created as it does not map to a valid cluster.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	false	none	none

readAllSourceTopics

Code samples

# You can also use wget
curl -X GET /admin/sourcetopics \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /sourcetopics

List all source topics created by the current user in an organization.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The page number of results to retrieve. If this number exceeds the available data, then the last page is returned.
maxPageSize	query	integer	false	The maximum number of entries to return per page. If not specified, all data items are returned.
filterBy	query	string	false	Capability to filter by.

Enumerated Values

Parameter	Value
filterBy	consume
filterBy	produce

Example responses

200 Response

[
  {
    "id": "string",
    "owner": "string",
    "organization": "string",
    "clusterId": "string",
    "type": "kafka",
    "encoding": "unknown",
    "name": "string",
    "contact": "string",
    "description": "string",
    "topic": {
      "name": "string",
      "partitions": 0,
      "replicas": 0,
      "uuid": "string"
    },
    "schema": {
      "type": "avro",
      "content": "string",
      "description": "string"
    },
    "tags": [
      "string"
    ],
    "sampleMessages": [
      "string"
    ],
    "capabilities": [
      "consume"
    ],
    "validation": {
      "status": "pending",
      "gatewayGroups": [
        {
          "name": "string",
          "status": "pending",
          "gateways": [
            {
              "id": "string",
              "validationErrors": [
                "notFound"
              ]
            }
          ]
        }
      ]
    },
    "collaborators": {
      "groups": [
        "string"
      ],
      "contacts": [
        "string"
      ]
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Source topics successfully listed.	Inline
304	Not Modified	Data not changed.	None
400	Bad Request	Invalid request, only one of page and maxPageSize were supplied or max page size exceeded.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique source topic ID.
» owner	string	true	none	Source topic owner.
» organization	string	true	none	Organization that this source topic belongs to.
» clusterId	string	true	none	ID for the cluster that contains the connection details for this source topic.
» type	string	true	none	Type of source topic.
» encoding	string	true	none	The encoding of the data on this source topic.
» name	string	true	none	Source topic name.
» contact	string	true	none	Who to contact for more information about this source topic.
» description	string	false	none	A description for this source topic.
» topic	object	false	none	none
»» name	string	true	none	Actual topic name in the cluster.
»» partitions	number	false	none	The number of partitions for this topic. Discovered from the Kafka cluster.
»» replicas	number	false	none	The number of replicas for this topic. Discovered from the Kafka cluster.
»» uuid	string	false	none	The UUID of the topic. Discovered from the Kafka cluster.
» schema	object	false	none	none
»» type	string	false	none	Type of schema from the list of valid types.
»» content	string	false	none	Contents of the schema.
»» description	string	false	none	Description of the data available on the source topic.
» tags	[string]	false	none	List of tags associated with this source topic.
» sampleMessages	[string]	false	none	none
» capabilities	[string]	true	none	none
» validation	object	false	none	Details of the visibility of this source topic amongst the gateway groups.
»» status	string	true	none	Status for all of the gateway groups. Can they see the topic associated with this source topic?
»» gatewayGroups	[object]	true	none	Gateway group names and if they can connect to this cluster and find the associated topic.
»»» name	string	true	none	none
»»» status	string	true	none	Status on whether this gateway group can see the topic associated with this source topic.
»»» gateways	[object]	true	none	none
»»»» id	string	true	none	none
»»»» validationErrors	[string]	true	none	List of failed validation stages. If this array is empty, then gateway group can access the topic.
» collaborators	object	true	none	none
»» groups	[string]	true	none	List of collaborators for this source topic.
»» contacts	[string]	true	none	List of contacts for this source topic.

Enumerated Values

Property	Value
type	kafka
encoding	unknown
encoding	text/plain
encoding	application/octet-stream
encoding	application/json
encoding	avro/binary
encoding	avro/json
type	avro
type	json
type	unknown
status	pending
status	error
status	success/partial
status	success
status	pending
status	error
status	success/partial
status	success

Response Headers

Status	Header	Type	Format	Description
200	ei-pagination-total	integer		Total number of items available for retrieval (including current page).
200	etag	string		An identifier that can be supplied with the If-None-Match header to indicate that unchanged results should return 304 with no data.

createSourceTopic

Code samples

# You can also use wget
curl -X POST /admin/sourcetopics \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /sourcetopics

Create a source topic.

Body parameter

{
  "clusterId": "string",
  "type": "kafka",
  "encoding": "unknown",
  "name": "string",
  "contact": "string",
  "description": "string",
  "topic": {
    "name": "string",
    "partitions": 0,
    "replicas": 0,
    "uuid": "stringstringstringst"
  },
  "schema": {
    "type": "avro",
    "content": "string",
    "description": "string"
  },
  "tags": [
    "string"
  ],
  "sampleMessages": [
    "string"
  ],
  "capabilities": [
    "consume"
  ],
  "collaborators": {
    "groups": [
      "string"
    ],
    "contacts": [
      "string"
    ]
  }
}

Parameters

Name	In	Type	Required	Description
disableValidation	query	boolean	false	Disable immediate validation against the remote server.
body	body	object	true	Source topic data.
» clusterId	body	string	true	ID for the cluster that contains the connection details for this source topic.
» type	body	string	true	Type of source topic.
» encoding	body	string	true	The encoding of the data on this source topic.
» name	body	string	true	Source topic name.
» contact	body	string	true	Who to contact for more information about this source topic.
» description	body	string	false	A description for this source topic.
» topic	body	object	false	none
»» name	body	string	true	Actual topic name in the cluster.
»» partitions	body	number	false	The number of partitions for this topic, updated by discovery.
»» replicas	body	number	false	The number of replicas for this topic, updated by discovery.
»» uuid	body	string	false	The UUID of the topic, updated by discovery.
» schema	body	object	false	none
»» type	body	string	false	Type of schema from the list of valid types.
»» content	body	string	false	Contents of the schema.
»» description	body	string	false	Description of the data available on the source topic.
»» anonymous	body	object	false	none
»» anonymous	body	object	false	none
» tags	body	[string]	false	List of tags associated with this source topic.
» sampleMessages	body	[string]	false	none
» capabilities	body	[string]	false	none
» collaborators	body	object	false	none
»» groups	body	[string]	true	List of collaborators for this source topic.
»» contacts	body	[string]	true	List of contacts for this source topic.

Enumerated Values

Parameter	Value
» type	kafka
» encoding	unknown
» encoding	text/plain
» encoding	application/octet-stream
» encoding	application/json
» encoding	avro/binary
» encoding	avro/json
»» type	avro
»» type	json
»» type	unknown
» capabilities	consume
» capabilities	produce

Example responses

200 Response

{
  "id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The ID of the created source topic.	Inline
400	Bad Request	Invalid request, request data does not match the schema.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
409	Conflict	Source topic could not be created due to a conflict.	None
422	Unprocessable Entity	Source topic could not be created as it does not map to a valid cluster.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	false	none	none

readEventSource

Code samples

# You can also use wget
curl -X GET /admin/eventsources/{eventSourceId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /eventsources/{eventSourceId}

Read a source topic.

Parameters

Name	In	Type	Required	Description
eventSourceId	path	string	true	The ID of the source topic to read.

Example responses

200 Response

{
  "id": "string",
  "owner": "string",
  "organization": "string",
  "clusterId": "string",
  "type": "kafka",
  "encoding": "unknown",
  "name": "string",
  "contact": "string",
  "description": "string",
  "topic": {
    "name": "string",
    "partitions": 0,
    "replicas": 0,
    "uuid": "string"
  },
  "schema": {
    "type": "avro",
    "content": "string",
    "description": "string"
  },
  "tags": [
    "string"
  ],
  "sampleMessages": [
    "string"
  ],
  "capabilities": [
    "consume"
  ],
  "validation": {
    "status": "pending",
    "gatewayGroups": [
      {
        "name": "string",
        "status": "pending",
        "gateways": [
          {
            "id": "string",
            "validationErrors": [
              "notFound"
            ]
          }
        ]
      }
    ]
  },
  "collaborators": {
    "groups": [
      "string"
    ],
    "contacts": [
      "string"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	The data for the requested source topic.	Inline
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	This source topic does not exist.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique source topic ID.
» owner	string	true	none	Source topic owner.
» organization	string	true	none	Organization that this source topic belongs to.
» clusterId	string	true	none	ID for the cluster that contains the connection details for this source topic.
» type	string	true	none	Type of source topic.
» encoding	string	true	none	The encoding of the data on this source topic.
» name	string	true	none	Source topic name.
» contact	string	true	none	Who to contact for more information about this source topic.
» description	string	false	none	A description for this source topic.
» topic	object	false	none	none
»» name	string	true	none	Actual topic name in the cluster.
»» partitions	number	false	none	The number of partitions for this topic. Discovered from the Kafka cluster.
»» replicas	number	false	none	The number of replicas for this topic. Discovered from the Kafka cluster.
»» uuid	string	false	none	The UUID of the topic. Discovered from the Kafka cluster.
» schema	object	false	none	none
»» type	string	false	none	Type of schema from the list of valid types.
»» content	string	false	none	Contents of the schema.
»» description	string	false	none	Description of the data available on the source topic.
» tags	[string]	false	none	List of tags associated with this source topic.
» sampleMessages	[string]	false	none	none
» capabilities	[string]	true	none	none
» validation	object	false	none	Details of the visibility of this source topic amongst the gateway groups.
»» status	string	true	none	Status for all of the gateway groups. Can they see the topic associated with this source topic?
»» gatewayGroups	[object]	true	none	Gateway group names and if they can connect to this cluster and find the associated topic.
»»» name	string	true	none	none
»»» status	string	true	none	Status on whether this gateway group can see the topic associated with this source topic.
»»» gateways	[object]	true	none	none
»»»» id	string	true	none	none
»»»» validationErrors	[string]	true	none	List of failed validation stages. If this array is empty, then gateway group can access the topic.
» collaborators	object	true	none	none
»» groups	[string]	true	none	List of collaborators for this source topic.
»» contacts	[string]	true	none	List of contacts for this source topic.

Enumerated Values

Property	Value
type	kafka
encoding	unknown
encoding	text/plain
encoding	application/octet-stream
encoding	application/json
encoding	avro/binary
encoding	avro/json
type	avro
type	json
type	unknown
status	pending
status	error
status	success/partial
status	success
status	pending
status	error
status	success/partial
status	success

updateEventSource

Code samples

# You can also use wget
curl -X PUT /admin/eventsources/{eventSourceId} \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT /eventsources/{eventSourceId}

Update a source topic.

Body parameter

{
  "clusterId": "string",
  "type": "kafka",
  "encoding": "unknown",
  "name": "string",
  "contact": "string",
  "description": "string",
  "topic": {
    "name": "string",
    "partitions": 0,
    "replicas": 0,
    "uuid": "stringstringstringst"
  },
  "schema": {
    "type": "avro",
    "content": "string",
    "description": "string"
  },
  "tags": [
    "string"
  ],
  "sampleMessages": [
    "string"
  ],
  "capabilities": [
    "consume"
  ],
  "collaborators": {
    "groups": [
      "string"
    ],
    "contacts": [
      "string"
    ]
  }
}

Parameters

Name	In	Type	Required	Description
eventSourceId	path	string	true	The ID of the source topic to update.
disableValidation	query	boolean	false	Disable immediate validation against the remote server.
body	body	object	true	Source topic data.
» clusterId	body	string	true	ID for the cluster that contains the connection details for this source topic.
» type	body	string	true	Type of source topic.
» encoding	body	string	true	The encoding of the data on this source topic.
» name	body	string	true	Source topic name.
» contact	body	string	true	Who to contact for more information about this source topic.
» description	body	string	false	A description for this source topic.
» topic	body	object	false	none
»» name	body	string	true	Actual topic name in the cluster.
»» partitions	body	number	false	The number of partitions for this topic, updated by discovery.
»» replicas	body	number	false	The number of replicas for this topic, updated by discovery.
»» uuid	body	string	false	The UUID of the topic, updated by discovery.
» schema	body	object	false	none
»» type	body	string	false	Type of schema from the list of valid types.
»» content	body	string	false	Contents of the schema.
»» description	body	string	false	Description of the data available on the source topic.
»» anonymous	body	object	false	none
»» anonymous	body	object	false	none
» tags	body	[string]	false	List of tags associated with this source topic.
» sampleMessages	body	[string]	false	none
» capabilities	body	[string]	false	none
» collaborators	body	object	false	none
»» groups	body	[string]	true	List of collaborators for this source topic.
»» contacts	body	[string]	true	List of contacts for this source topic.

Enumerated Values

Parameter	Value
» type	kafka
» encoding	unknown
» encoding	text/plain
» encoding	application/octet-stream
» encoding	application/json
» encoding	avro/binary
» encoding	avro/json
»» type	avro
»» type	json
»» type	unknown
» capabilities	consume
» capabilities	produce

Responses

Status	Meaning	Description	Schema
200	OK	Source topic successfully updated.	None
400	Bad Request	Invalid request, request data does not match the schema.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	This source topic does not exist.	None
409	Conflict	Source topic could not be updated due to a conflict.	None
422	Unprocessable Entity	Source topic could not be created as it does not map to a valid cluster.	None
500	Internal Server Error	Internal error.	None

deleteEventSource

Code samples

# You can also use wget
curl -X DELETE /admin/eventsources/{eventSourceId} \
  -H 'Authorization: Bearer {access-token}'

DELETE /eventsources/{eventSourceId}

Delete a source topic

The source topic must have no attached published or archived virtual topics. Note - You must be the owner to delete a source topic. You can view all of the source topics that you own (including their ID) by using GET /eventsources

Parameters

Name	In	Type	Required	Description
eventSourceId	path	string	true	The ID of the source topic to delete.

Responses

Status	Meaning	Description	Schema
200	OK	Source topic successfully deleted.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	This source topic does not exist.	None
409	Conflict	Source topic could not be deleted due to a conflict.	None
500	Internal Server Error	Internal error.	None

readSourceTopic

Code samples

# You can also use wget
curl -X GET /admin/sourcetopics/{sourceTopicId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /sourcetopics/{sourceTopicId}

Read a source topic.

Parameters

Name	In	Type	Required	Description
sourceTopicId	path	string	true	The ID of the source topic.

Example responses

200 Response

{
  "id": "string",
  "owner": "string",
  "organization": "string",
  "clusterId": "string",
  "type": "kafka",
  "encoding": "unknown",
  "name": "string",
  "contact": "string",
  "description": "string",
  "topic": {
    "name": "string",
    "partitions": 0,
    "replicas": 0,
    "uuid": "string"
  },
  "schema": {
    "type": "avro",
    "content": "string",
    "description": "string"
  },
  "tags": [
    "string"
  ],
  "sampleMessages": [
    "string"
  ],
  "capabilities": [
    "consume"
  ],
  "validation": {
    "status": "pending",
    "gatewayGroups": [
      {
        "name": "string",
        "status": "pending",
        "gateways": [
          {
            "id": "string",
            "validationErrors": [
              "notFound"
            ]
          }
        ]
      }
    ]
  },
  "collaborators": {
    "groups": [
      "string"
    ],
    "contacts": [
      "string"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	The data for the requested source topic.	Inline
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	This source topic does not exist.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique source topic ID.
» owner	string	true	none	Source topic owner.
» organization	string	true	none	Organization that this source topic belongs to.
» clusterId	string	true	none	ID for the cluster that contains the connection details for this source topic.
» type	string	true	none	Type of source topic.
» encoding	string	true	none	The encoding of the data on this source topic.
» name	string	true	none	Source topic name.
» contact	string	true	none	Who to contact for more information about this source topic.
» description	string	false	none	A description for this source topic.
» topic	object	false	none	none
»» name	string	true	none	Actual topic name in the cluster.
»» partitions	number	false	none	The number of partitions for this topic. Discovered from the Kafka cluster.
»» replicas	number	false	none	The number of replicas for this topic. Discovered from the Kafka cluster.
»» uuid	string	false	none	The UUID of the topic. Discovered from the Kafka cluster.
» schema	object	false	none	none
»» type	string	false	none	Type of schema from the list of valid types.
»» content	string	false	none	Contents of the schema.
»» description	string	false	none	Description of the data available on the source topic.
» tags	[string]	false	none	List of tags associated with this source topic.
» sampleMessages	[string]	false	none	none
» capabilities	[string]	true	none	none
» validation	object	false	none	Details of the visibility of this source topic amongst the gateway groups.
»» status	string	true	none	Status for all of the gateway groups. Can they see the topic associated with this source topic?
»» gatewayGroups	[object]	true	none	Gateway group names and if they can connect to this cluster and find the associated topic.
»»» name	string	true	none	none
»»» status	string	true	none	Status on whether this gateway group can see the topic associated with this source topic.
»»» gateways	[object]	true	none	none
»»»» id	string	true	none	none
»»»» validationErrors	[string]	true	none	List of failed validation stages. If this array is empty, then gateway group can access the topic.
» collaborators	object	true	none	none
»» groups	[string]	true	none	List of collaborators for this source topic.
»» contacts	[string]	true	none	List of contacts for this source topic.

Enumerated Values

Property	Value
type	kafka
encoding	unknown
encoding	text/plain
encoding	application/octet-stream
encoding	application/json
encoding	avro/binary
encoding	avro/json
type	avro
type	json
type	unknown
status	pending
status	error
status	success/partial
status	success
status	pending
status	error
status	success/partial
status	success

updateSourceTopic

Code samples

# You can also use wget
curl -X PUT /admin/sourcetopics/{sourceTopicId} \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT /sourcetopics/{sourceTopicId}

Update a source topic.

Body parameter

{
  "clusterId": "string",
  "type": "kafka",
  "encoding": "unknown",
  "name": "string",
  "contact": "string",
  "description": "string",
  "topic": {
    "name": "string",
    "partitions": 0,
    "replicas": 0,
    "uuid": "stringstringstringst"
  },
  "schema": {
    "type": "avro",
    "content": "string",
    "description": "string"
  },
  "tags": [
    "string"
  ],
  "sampleMessages": [
    "string"
  ],
  "capabilities": [
    "consume"
  ],
  "collaborators": {
    "groups": [
      "string"
    ],
    "contacts": [
      "string"
    ]
  }
}

Parameters

Name	In	Type	Required	Description
sourceTopicId	path	string	true	The ID of the source topic.
disableValidation	query	boolean	false	Disable immediate validation against the remote server.
body	body	object	true	Source topic data.
» clusterId	body	string	true	ID for the cluster that contains the connection details for this source topic.
» type	body	string	true	Type of source topic.
» encoding	body	string	true	The encoding of the data on this source topic.
» name	body	string	true	Source topic name.
» contact	body	string	true	Who to contact for more information about this source topic.
» description	body	string	false	A description for this source topic.
» topic	body	object	false	none
»» name	body	string	true	Actual topic name in the cluster.
»» partitions	body	number	false	The number of partitions for this topic, updated by discovery.
»» replicas	body	number	false	The number of replicas for this topic, updated by discovery.
»» uuid	body	string	false	The UUID of the topic, updated by discovery.
» schema	body	object	false	none
»» type	body	string	false	Type of schema from the list of valid types.
»» content	body	string	false	Contents of the schema.
»» description	body	string	false	Description of the data available on the source topic.
»» anonymous	body	object	false	none
»» anonymous	body	object	false	none
» tags	body	[string]	false	List of tags associated with this source topic.
» sampleMessages	body	[string]	false	none
» capabilities	body	[string]	false	none
» collaborators	body	object	false	none
»» groups	body	[string]	true	List of collaborators for this source topic.
»» contacts	body	[string]	true	List of contacts for this source topic.

Enumerated Values

Parameter	Value
» type	kafka
» encoding	unknown
» encoding	text/plain
» encoding	application/octet-stream
» encoding	application/json
» encoding	avro/binary
» encoding	avro/json
»» type	avro
»» type	json
»» type	unknown
» capabilities	consume
» capabilities	produce

Responses

Status	Meaning	Description	Schema
200	OK	Source topic successfully updated.	None
400	Bad Request	Invalid request, request data does not match the schema.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	This source topic does not exist.	None
409	Conflict	Source topic could not be updated due to a conflict.	None
422	Unprocessable Entity	Source topic could not be created as it does not map to a valid cluster.	None
500	Internal Server Error	Internal error.	None

deleteSourceTopic

Code samples

# You can also use wget
curl -X DELETE /admin/sourcetopics/{sourceTopicId} \
  -H 'Authorization: Bearer {access-token}'

DELETE /sourcetopics/{sourceTopicId}

Delete a source topic

The source topic must have no attached published or archived virtual topics. Note - You must be the owner to delete a source topic. You can view all of the source topics that you own (including their ID) by using GET /eventsources

Parameters

Name	In	Type	Required	Description
sourceTopicId	path	string	true	The ID of the source topic.

Responses

Status	Meaning	Description	Schema
200	OK	Source topic successfully deleted.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	This source topic does not exist.	None
409	Conflict	Source topic could not be deleted due to a conflict.	None
500	Internal Server Error	Internal error.	None

readEventSourceSubscriptions

Code samples

# You can also use wget
curl -X GET /admin/eventsources/{eventSourceId}/subscriptions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /eventsources/{eventSourceId}/subscriptions

Read a list of subscriptions to this source topic. This endpoint is now deprecated. Use /sourcetopic/{sourceTopicId}/applicationsubscriptions endpoint instead.

Parameters

Name	In	Type	Required	Description
eventSourceId	path	string	true	The ID of the source topic to read subscriptions for.
page	query	integer	false	The page number of results to retrieve. If this number exceeds the available data, then the last page is returned.
maxPageSize	query	integer	false	The maximum number of entries to return per page. If not specified, all data items are returned.

Example responses

200 Response

[
  {
    "id": "string",
    "username": "string",
    "contact": "string",
    "eventSource": {
      "id": "string",
      "name": "string"
    },
    "option": {
      "id": "string",
      "name": "string"
    },
    "apicSubscription": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Source topic subscriptions read successfully.	Inline
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	This source topic does not exist.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique subscription ID.
» username	string	true	none	Username created for this subscription.
» contact	string	true	none	The contact details of the owner of this subscription.
» eventSource	object	true	none	Information about the source topic this subscription is for.
»» id	string	true	none	Unique source topic ID.
»» name	string	true	none	Source topic name.
» option	object	true	none	Information about the option this subscription is for.
»» id	string	true	none	Unique virtual topic ID.
»» name	string	true	none	Virtual topic name.
» apicSubscription	boolean	false	none	Subscription added by API Connect.

Response Headers

Status	Header	Type	Format	Description
200	ei-pagination-total	integer		Total number of items available for retrieval (including current page).
200	etag	string		An identifier that can be supplied with the If-None-Match header to indicate that unchanged results should return 304 with no data.

readSourceTopicApplicationSubscriptions

Code samples

# You can also use wget
curl -X GET /admin/sourcetopics/{sourceTopicId}/applicationsubscriptions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /sourcetopics/{sourceTopicId}/applicationsubscriptions

Read a list of application subscriptions to this source topic.

Parameters

Name	In	Type	Required	Description
sourceTopicId	path	string	true	The ID of the source topic.
page	query	integer	false	The page number of results to retrieve. If this number exceeds the available data, then the last page is returned.
maxPageSize	query	integer	false	The maximum number of entries to return per page. If not specified, all data items are returned.

Example responses

200 Response

[
  {
    "id": "string",
    "name": "string",
    "usernames": [
      "string"
    ],
    "contact": "string",
    "sourceTopic": {
      "id": "string",
      "name": "string"
    },
    "virtualTopic": {
      "id": "string",
      "name": "string"
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Source topic application subscriptions read successfully.	Inline
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	This source topic does not exist.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique Application ID.
» name	string	true	none	Application Name.
» usernames	[string]	true	none	Usernames, subjects or common names for this Application.
» contact	string	true	none	The contact details of the owner of this Application Subscription.
» sourceTopic	object	true	none	Information about the Source Topic this Application Subscription is for.
»» id	string	true	none	Unique Source Topic ID.
»» name	string	true	none	Source Topic name.
» virtualTopic	object	true	none	Information about the Virtual Topic this Application Subscription is for.
»» id	string	true	none	Unique Virtual Topic ID.
»» name	string	true	none	Virtual Topic name.

Response Headers

Status	Header	Type	Format	Description
200	ei-pagination-total	integer		Total number of items available for retrieval (including current page).
200	etag	string		An identifier that can be supplied with the If-None-Match header to indicate that unchanged results should return 304 with no data.

readAllOptions

Code samples

# You can also use wget
curl -X GET /admin/options \
  -H 'Accept: application/vnd.ibm.eem.v2+json' \
  -H 'Authorization: Bearer {access-token}'

GET /options

List all options created by the current user in an organization. This endpoint is now deprecated. Use /virtualtopics endpoint instead.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The page number of results to retrieve. If this number exceeds the available data, then the last page is returned.
maxPageSize	query	integer	false	The maximum number of entries to return per page. If not specified, all data items are returned.

Example responses

200 Response

application/vnd.ibm.eem.v2+json

[
  {
    "id": "string",
    "owner": "string",
    "organization": "string",
    "eventSourceId": "string",
    "alias": "string",
    "name": "string",
    "description": "string",
    "gatewayGroups": [
      "string"
    ],
    "catalogs": [
      {
        "id": "string",
        "state": "published"
      }
    ],
    "hidden": true,
    "allowSubscriptions": true,
    "controls": [
      {
        "id": "string",
        "type": "approval",
        "requests": [
          {
            "id": "string",
            "owner": "string",
            "lastUpdated": 0,
            "status": "pending",
            "description": "string",
            "contact": "string",
            "outcome": "string",
            "subscriptionId": "string",
            "applicationId": "string"
          }
        ]
      }
    ],
    "groupVisibility": [
      "string"
    ]
  }
]

application/json

[
  {
    "id": "string",
    "owner": "string",
    "organization": "string",
    "eventSourceId": "string",
    "alias": "string",
    "name": "string",
    "description": "string",
    "gatewayGroups": [
      "string"
    ],
    "hidden": true,
    "allowSubscriptions": true,
    "catalogs": [
      {
        "id": "string",
        "state": "published"
      }
    ],
    "controls": [
      {
        "id": "string",
        "type": "approval",
        "requests": [
          {
            "id": "string",
            "owner": "string",
            "lastUpdated": 0,
            "status": "pending",
            "description": "string",
            "contact": "string",
            "outcome": "string",
            "subscriptionId": "string",
            "applicationId": "string"
          }
        ]
      }
    ],
    "groupVisibility": [
      "string"
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Options successfully listed.	Inline
304	Not Modified	Data not changed.	None
400	Bad Request	Invalid request, only one of page and maxPageSize were supplied or max page size exceeded.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
406	Not Acceptable	Not Acceptable. The requested media type is not supported.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

application/vnd.ibm.eem.v2+json (V2 API)

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique option ID.
» owner	string	true	none	Option owner.
» organization	string	true	none	Organization this option belongs to.
» eventSourceId	string	true	none	Source topic that this option belongs to.
» alias	string	true	none	Unique, descriptive alias for this option.
» name	string	true	none	Descriptive name for this option.
» description	string	false	none	Longer description used to describe what this option is used for.
» gatewayGroups	[string]	true	none	List of gateway groups this option should be published to.
» catalogs	[object]	false	none	List of catalogs to which the option is published.
»» id	string	true	none	Unique catalog ID.
»» state	string	false	none	Indicates if this option is published, unpublished or archived.
» hidden	boolean	true	none	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this option is visible in the catalog.
» allowSubscriptions	boolean	true	none	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this option is allowing new subscriptions.
» controls	[anyOf]	true	none	Controls on this virtual topic.

anyOf

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» requests	[object]	true	none	none
»»»» id	string	true	none	Unique approval request ID.
»»»» owner	string	true	none	Approval request owner.
»»»» lastUpdated	integer	false	none	Unix Epoch timestamp of last update to approval request.
»»»» status	string	true	none	The status of this approval request.
»»»» description	string	true	none	Description of why the request was created.
»»»» contact	string	true	none	Contact details of the person making the request.
»»»» outcome	string	false	none	Description of the outcome of this request.
»»»» subscriptionId	string	false	none	The id of the subscription associated with this request.
»»»» applicationId	string	false	none	The id of the application associated with this request.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» redactions	[anyOf]	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	Type of redaction.
»»»»»» replaceWith	string	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	any	true	none	Type of redaction.
»»»»»» replaceWith	number	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	Type of redaction.
»»»»»» algorithm	string	true	none	Algorithm to use for hashing the current value.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» schema	object	true	none	none
»»»» filtered	boolean	true	none	If true, any schema associated with the source topic will be used to filter records sent to applications.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	false	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	false	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»» anonymous	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» trustPem	string	true	none	Certificate Authority in PEM format.

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.
»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

and

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» identificationType	string	false	none	The type of identification users will use to distinguish between subscriptions. Defaults to MTLS when not provided.
»»»» identificationSubjectFields	[string]	false	none	Certificate subject fields to identify users by if using MTLS identificationType.
»»»» subjectCommonName	string	true	none	Subject Common Name to match on.
»»»» subjectOrganization	string	false	none	Subject Organization to match on.
»»»» subjectCountry	string	false	none	Subject Country to match on.
»»»» subjectStateOrProvince	string	false	none	Subject Region to match on.
»»»» subjectLocality	string	false	none	Subject Locality to match on.
»»»» approvedCipherSuites	[string]	false	none	Cipher suites that are approved for use.
»»»» disapprovedCipherSuites	[string]	false	none	Cipher suites that are not approved for use.
»»»» notValidBefore	integer	false	none	Certificate not valid before time.
»»»» notValidAfter	integer	false	none	Certificate not valid after time.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» filterCondition	object	true	none	none
»»»» type	string	true	none	none
»»»» eventProperty	object	true	none	none
»»»»» path	string	true	none	JSONPath to the field.
»»»»» source	string	true	none	Location of the property in the event.
»»»» operator	object	true	none	none
»»»»» name	string	true	none	none
»»»»» type	string	true	none	none
»»»» value	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	none
»»»»»» value	any	true	none	Literal comparison value.

oneOf

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	string	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	number	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	boolean	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	none
»»»»»» value	string	true	none	Reference to a Kafka connection metadata property.

continued

Name	Type	Required	Restrictions	Description
» groupVisibility	[string]	true	none	List of groups this option should be visible to in the catalog.

Enumerated Values

Property	Value
state	published
state	unpublished
state	archived
type	approval
status	pending
status	approved
status	rejected
status	fulfilled
type	redaction
type	replaceString
type	replaceIntegral
type	replaceDouble
type	hash
algorithm	SHA-256
algorithm	SHA-512
type	schema-filtering
type	quota
type	mtls
identificationType	MTLS
identificationType	SASL
type	sasl-oauth
type	sasl-credentials
type	content-filtering
type	simple
source	body
name	equal
type	string
type	integer
type	double
type	boolean
type	literal
type	reference
value	USER_ID
value	CLIENT_ID

application/json (V1 API)

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique option ID.
» owner	string	true	none	Option owner.
» organization	string	true	none	Organization this option belongs to.
» eventSourceId	string	true	none	Source topic that this option belongs to.
» alias	string	true	none	Unique, descriptive alias for this option.
» name	string	true	none	Descriptive name for this option.
» description	string	false	none	Longer description used to describe what this option is used for.
» gatewayGroups	[string]	true	none	List of gateway groups this option should be published to.
» hidden	boolean	true	none	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this option is visible in the catalog.
» allowSubscriptions	boolean	true	none	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this option is allowing new subscriptions.
» catalogs	[object]	false	none	List of catalogs to which the option is published.
»» id	string	true	none	Unique catalog ID.
»» state	string	false	none	Indicates if this option is published, unpublished or archived.
» controls	[anyOf]	true	none	Controls on this virtual topic.

anyOf

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» requests	[object]	true	none	none
»»»» id	string	true	none	Unique approval request ID.
»»»» owner	string	true	none	Approval request owner.
»»»» lastUpdated	integer	false	none	Unix Epoch timestamp of last update to approval request.
»»»» status	string	true	none	The status of this approval request.
»»»» description	string	true	none	Description of why the request was created.
»»»» contact	string	true	none	Contact details of the person making the request.
»»»» outcome	string	false	none	Description of the outcome of this request.
»»»» subscriptionId	string	false	none	The id of the subscription associated with this request.
»»»» applicationId	string	false	none	The id of the application associated with this request.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» redactions	[anyOf]	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	Type of redaction.
»»»»»» replaceWith	string	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	any	true	none	Type of redaction.
»»»»»» replaceWith	number	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	Type of redaction.
»»»»»» algorithm	string	true	none	Algorithm to use for hashing the current value.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» schema	object	true	none	none
»»»» filtered	boolean	true	none	If true, any schema associated with the source topic will be used to filter records sent to applications.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	false	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	false	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»» anonymous	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» trustPem	string	true	none	Certificate Authority in PEM format.

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.
»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

and

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» identificationType	string	false	none	The type of identification users will use to distinguish between subscriptions. Defaults to MTLS when not provided.
»»»» identificationSubjectFields	[string]	false	none	Certificate subject fields to identify users by if using MTLS identificationType.
»»»» subjectCommonName	string	true	none	Subject Common Name to match on.
»»»» subjectOrganization	string	false	none	Subject Organization to match on.
»»»» subjectCountry	string	false	none	Subject Country to match on.
»»»» subjectStateOrProvince	string	false	none	Subject Region to match on.
»»»» subjectLocality	string	false	none	Subject Locality to match on.
»»»» approvedCipherSuites	[string]	false	none	Cipher suites that are approved for use.
»»»» disapprovedCipherSuites	[string]	false	none	Cipher suites that are not approved for use.
»»»» notValidBefore	integer	false	none	Certificate not valid before time.
»»»» notValidAfter	integer	false	none	Certificate not valid after time.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» filterCondition	object	true	none	none
»»»» type	string	true	none	none
»»»» eventProperty	object	true	none	none
»»»»» path	string	true	none	JSONPath to the field.
»»»»» source	string	true	none	Location of the property in the event.
»»»» operator	object	true	none	none
»»»»» name	string	true	none	none
»»»»» type	string	true	none	none
»»»» value	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	none
»»»»»» value	any	true	none	Literal comparison value.

oneOf

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	string	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	number	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	boolean	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	none
»»»»»» value	string	true	none	Reference to a Kafka connection metadata property.

continued

Name	Type	Required	Restrictions	Description
» groupVisibility	[string]	true	none	List of groups this option should be visible to in the catalog.

Enumerated Values

Property	Value
state	published
state	unpublished
state	archived
type	approval
status	pending
status	approved
status	rejected
status	fulfilled
type	redaction
type	replaceString
type	replaceIntegral
type	replaceDouble
type	hash
algorithm	SHA-256
algorithm	SHA-512
type	schema-filtering
type	quota
type	mtls
identificationType	MTLS
identificationType	SASL
type	content-filtering
type	simple
source	body
name	equal
type	string
type	integer
type	double
type	boolean
type	literal
type	reference
value	USER_ID
value	CLIENT_ID

Response Headers

Status	Header	Type	Format	Description
200	ei-pagination-total	integer		Total number of items available for retrieval (including current page).
200	etag	string		An identifier that can be supplied with the If-None-Match header to indicate that unchanged results should return 304 with no data.

createOption

Code samples

# You can also use wget
curl -X POST /admin/options \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /options

Create an option. This endpoint is now deprecated. Use /virtualtopics endpoint instead.

Body parameter

{
  "eventSourceId": "string",
  "alias": "string",
  "name": "string",
  "description": "string",
  "gatewayGroups": [
    "string"
  ],
  "catalogs": [
    {
      "id": "string",
      "state": "published"
    }
  ],
  "hidden": true,
  "allowSubscriptions": true,
  "controls": [
    {
      "id": "string",
      "type": "approval",
      "requests": [
        {
          "id": "string",
          "owner": "string",
          "lastUpdated": 0,
          "status": "pending",
          "description": "string",
          "contact": "string",
          "outcome": "string",
          "subscriptionId": "string",
          "applicationId": "string"
        }
      ]
    }
  ],
  "groupVisibility": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	Option data.
» eventSourceId	body	string	true	Source topic that this option belongs to.
» alias	body	string	true	Unique, descriptive alias for this option.
» name	body	string	true	Descriptive name for this option.
» description	body	string	false	Longer description used to describe what this option is used for.
» gatewayGroups	body	[string]	true	List of gateway groups this option should be published to.
» catalogs	body	[object]	false	List of catalogs to which the option is published.
»» id	body	string	true	Unique catalog ID.
»» state	body	string	false	Indicates if this option is published, unpublished or archived.
» hidden	body	boolean	true	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this option is visible in the catalog.
» allowSubscriptions	body	boolean	true	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this option is allowing new subscriptions.
» controls	body	[anyOf]	true	Controls on this virtual topic.
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»»» requests	body	[object]	true	none
»»»» id	body	string	true	Unique approval request ID.
»»»» owner	body	string	true	Approval request owner.
»»»» lastUpdated	body	integer	false	Unix Epoch timestamp of last update to approval request.
»»»» status	body	string	true	The status of this approval request.
»»»» description	body	string	true	Description of why the request was created.
»»»» contact	body	string	true	Contact details of the person making the request.
»»»» outcome	body	string	false	Description of the outcome of this request.
»»»» subscriptionId	body	string	false	The id of the subscription associated with this request.
»»»» applicationId	body	string	false	The id of the application associated with this request.
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»»» redactions	body	[anyOf]	true	none
»»»» anonymous	body	any	false	none
»»»»» anonymous	body	object	false	none
»»»»»» path	body	string	true	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).
»»»»» anonymous	body	object	false	none
»»»»»» type	body	string	true	Type of redaction.
»»»»»» replaceWith	body	string	true	The value to replace with.
»»»» anonymous	body	any	false	none
»»»»» anonymous	body	object	false	none
»»»»»» path	body	string	true	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).
»»»»» anonymous	body	object	false	none
»»»»»» type	body	any	true	Type of redaction.
»»»»»» replaceWith	body	number	true	The value to replace with.
»»»» anonymous	body	any	false	none
»»»»» anonymous	body	object	false	none
»»»»»» path	body	string	true	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).
»»»»» anonymous	body	object	false	none
»»»»»» type	body	string	true	Type of redaction.
»»»»»» algorithm	body	string	true	Algorithm to use for hashing the current value.
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»»» schema	body	object	true	none
»»»» filtered	body	boolean	true	If true, any schema associated with the source topic will be used to filter records sent to applications.
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»»» anonymous	body	object	false	none
»»»» megabytesPerSecond	body	number	true	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	body	number	false	Upper limit to messages per second produced/consumed.
»»» anonymous	body	object	false	none
»»»» megabytesPerSecond	body	number	false	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	body	number	true	Upper limit to messages per second produced/consumed.
»»» anonymous	body	object	false	none
»»»» megabytesPerSecond	body	number	true	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	body	number	true	Upper limit to messages per second produced/consumed.
»» anonymous	body	any	false	none
»»» anonymous	body	any	false	none
»»»» anonymous	body	object	false	none
»»»»» trustPem	body	string	true	Certificate Authority in PEM format.
»»»» anonymous	body	any	false	none
»»»»» anonymous	body	object	false	none
»»»»»» acceptProfileCa	body	boolean	true	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.
»»»»» anonymous	body	object	false	none
»»»»»» acceptOrgCa	body	boolean	true	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.
»»»»» anonymous	body	object	false	none
»»»»»» acceptProfileCa	body	boolean	true	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.
»»»»»» acceptOrgCa	body	boolean	true	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.
»»» anonymous	body	object	false	none
»»»» id	body	string	true	Unique control ID.
»»»» type	body	string	true	none
»»»» identificationType	body	string	false	The type of identification users will use to distinguish between subscriptions. Defaults to MTLS when not provided.
»»»» identificationSubjectFields	body	[string]	false	Certificate subject fields to identify users by if using MTLS identificationType.
»»»» subjectCommonName	body	string	true	Subject Common Name to match on.
»»»» subjectOrganization	body	string	false	Subject Organization to match on.
»»»» subjectCountry	body	string	false	Subject Country to match on.
»»»» subjectStateOrProvince	body	string	false	Subject Region to match on.
»»»» subjectLocality	body	string	false	Subject Locality to match on.
»»»» approvedCipherSuites	body	[string]	false	Cipher suites that are approved for use.
»»»» disapprovedCipherSuites	body	[string]	false	Cipher suites that are not approved for use.
»»»» notValidBefore	body	integer	false	Certificate not valid before time.
»»»» notValidAfter	body	integer	false	Certificate not valid after time.
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»»» filterCondition	body	object	true	none
»»»» type	body	string	true	none
»»»» eventProperty	body	object	true	none
»»»»» path	body	string	true	JSONPath to the field.
»»»»» source	body	string	true	Location of the property in the event.
»»»» operator	body	object	true	none
»»»»» name	body	string	true	none
»»»»» type	body	string	true	none
»»»» value	body	any	true	none
»»»»» anonymous	body	object	false	none
»»»»»» type	body	string	true	none
»»»»»» value	body	any	true	Literal comparison value.
»»»»»»» anonymous	body	string	false	none
»»»»»»» anonymous	body	number	false	none
»»»»»»» anonymous	body	boolean	false	none
»»»»» anonymous	body	object	false	none
»»»»»» type	body	string	true	none
»»»»»» value	body	string	true	Reference to a Kafka connection metadata property.
» groupVisibility	body	[string]	false	List of groups this option should be visible to in the catalog.

Enumerated Values

Parameter	Value
»» state	published
»» state	unpublished
»» state	archived
»»» type	approval
»»»» status	pending
»»»» status	approved
»»»» status	rejected
»»»» status	fulfilled
»»» type	redaction
»»»»»» type	replaceString
»»»»»» type	replaceIntegral
»»»»»» type	replaceDouble
»»»»»» type	hash
»»»»»» algorithm	SHA-256
»»»»»» algorithm	SHA-512
»»» type	schema-filtering
»»» type	quota
»»»» type	mtls
»»»» identificationType	MTLS
»»»» identificationType	SASL
»»»» identificationSubjectFields	subjectCommonName
»»»» identificationSubjectFields	subjectOrganization
»»»» identificationSubjectFields	subjectCountry
»»»» identificationSubjectFields	subjectStateOrProvince
»»»» identificationSubjectFields	subjectLocality
»»» type	sasl-oauth
»»» type	sasl-credentials
»»» type	content-filtering
»»»» type	simple
»»»»» source	body
»»»»» name	equal
»»»»» type	string
»»»»» type	integer
»»»»» type	double
»»»»» type	boolean
»»»»»» type	literal
»»»»»» type	reference
»»»»»» value	USER_ID
»»»»»» value	CLIENT_ID

Example responses

200 Response

{
  "id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The ID of the created option.	Inline
400	Bad Request	Invalid request, request data does not match schema or Controls specified not compatible with gateway group.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
426	Upgrade Required	Limit reached, upgrade required to your service plan.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	false	none	none

readOption

Code samples

# You can also use wget
curl -X GET /admin/options/{optionId} \
  -H 'Accept: application/vnd.ibm.eem.v2+json' \
  -H 'Authorization: Bearer {access-token}'

GET /options/{optionId}

Read an option. This endpoint is now deprecated. Use /virtualtopics/{virtualTopicId} endpoint instead.

Parameters

Name	In	Type	Required	Description
optionId	path	string	true	The ID of the option to read.

Example responses

200 Response

application/vnd.ibm.eem.v2+json

{
  "id": "string",
  "owner": "string",
  "organization": "string",
  "eventSourceId": "string",
  "alias": "string",
  "name": "string",
  "description": "string",
  "gatewayGroups": [
    "string"
  ],
  "catalogs": [
    {
      "id": "string",
      "state": "published"
    }
  ],
  "hidden": true,
  "allowSubscriptions": true,
  "controls": [
    {
      "id": "string",
      "type": "approval",
      "requests": [
        {
          "id": "string",
          "owner": "string",
          "lastUpdated": 0,
          "status": "pending",
          "description": "string",
          "contact": "string",
          "outcome": "string",
          "subscriptionId": "string",
          "applicationId": "string"
        }
      ]
    }
  ],
  "groupVisibility": [
    "string"
  ]
}

application/json

{
  "id": "string",
  "owner": "string",
  "organization": "string",
  "eventSourceId": "string",
  "alias": "string",
  "name": "string",
  "description": "string",
  "gatewayGroups": [
    "string"
  ],
  "hidden": true,
  "allowSubscriptions": true,
  "catalogs": [
    {
      "id": "string",
      "state": "published"
    }
  ],
  "controls": [
    {
      "id": "string",
      "type": "approval",
      "requests": [
        {
          "id": "string",
          "owner": "string",
          "lastUpdated": 0,
          "status": "pending",
          "description": "string",
          "contact": "string",
          "outcome": "string",
          "subscriptionId": "string",
          "applicationId": "string"
        }
      ]
    }
  ],
  "groupVisibility": [
    "string"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The data for the requested option.	Inline
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	This option does not exist.	None
406	Not Acceptable	Not Acceptable. The requested media type is not supported.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

application/vnd.ibm.eem.v2+json (V2 API)

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique option ID.
» owner	string	true	none	Option owner.
» organization	string	true	none	Organization this option belongs to.
» eventSourceId	string	true	none	Source topic that this option belongs to.
» alias	string	true	none	Unique, descriptive alias for this option.
» name	string	true	none	Descriptive name for this option.
» description	string	false	none	Longer description used to describe what this option is used for.
» gatewayGroups	[string]	true	none	List of gateway groups this option should be published to.
» catalogs	[object]	false	none	List of catalogs to which the option is published.
»» id	string	true	none	Unique catalog ID.
»» state	string	false	none	Indicates if this option is published, unpublished or archived.
» hidden	boolean	true	none	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this option is visible in the catalog.
» allowSubscriptions	boolean	true	none	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this option is allowing new subscriptions.
» controls	[anyOf]	true	none	Controls on this virtual topic.

anyOf

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» requests	[object]	true	none	none
»»»» id	string	true	none	Unique approval request ID.
»»»» owner	string	true	none	Approval request owner.
»»»» lastUpdated	integer	false	none	Unix Epoch timestamp of last update to approval request.
»»»» status	string	true	none	The status of this approval request.
»»»» description	string	true	none	Description of why the request was created.
»»»» contact	string	true	none	Contact details of the person making the request.
»»»» outcome	string	false	none	Description of the outcome of this request.
»»»» subscriptionId	string	false	none	The id of the subscription associated with this request.
»»»» applicationId	string	false	none	The id of the application associated with this request.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» redactions	[anyOf]	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	Type of redaction.
»»»»»» replaceWith	string	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	any	true	none	Type of redaction.
»»»»»» replaceWith	number	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	Type of redaction.
»»»»»» algorithm	string	true	none	Algorithm to use for hashing the current value.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» schema	object	true	none	none
»»»» filtered	boolean	true	none	If true, any schema associated with the source topic will be used to filter records sent to applications.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	false	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	false	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»» anonymous	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» trustPem	string	true	none	Certificate Authority in PEM format.

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.
»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

and

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» identificationType	string	false	none	The type of identification users will use to distinguish between subscriptions. Defaults to MTLS when not provided.
»»»» identificationSubjectFields	[string]	false	none	Certificate subject fields to identify users by if using MTLS identificationType.
»»»» subjectCommonName	string	true	none	Subject Common Name to match on.
»»»» subjectOrganization	string	false	none	Subject Organization to match on.
»»»» subjectCountry	string	false	none	Subject Country to match on.
»»»» subjectStateOrProvince	string	false	none	Subject Region to match on.
»»»» subjectLocality	string	false	none	Subject Locality to match on.
»»»» approvedCipherSuites	[string]	false	none	Cipher suites that are approved for use.
»»»» disapprovedCipherSuites	[string]	false	none	Cipher suites that are not approved for use.
»»»» notValidBefore	integer	false	none	Certificate not valid before time.
»»»» notValidAfter	integer	false	none	Certificate not valid after time.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» filterCondition	object	true	none	none
»»»» type	string	true	none	none
»»»» eventProperty	object	true	none	none
»»»»» path	string	true	none	JSONPath to the field.
»»»»» source	string	true	none	Location of the property in the event.
»»»» operator	object	true	none	none
»»»»» name	string	true	none	none
»»»»» type	string	true	none	none
»»»» value	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	none
»»»»»» value	any	true	none	Literal comparison value.

oneOf

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	string	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	number	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	boolean	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	none
»»»»»» value	string	true	none	Reference to a Kafka connection metadata property.

continued

Name	Type	Required	Restrictions	Description
» groupVisibility	[string]	true	none	List of groups this option should be visible to in the catalog.

Enumerated Values

Property	Value
state	published
state	unpublished
state	archived
type	approval
status	pending
status	approved
status	rejected
status	fulfilled
type	redaction
type	replaceString
type	replaceIntegral
type	replaceDouble
type	hash
algorithm	SHA-256
algorithm	SHA-512
type	schema-filtering
type	quota
type	mtls
identificationType	MTLS
identificationType	SASL
type	sasl-oauth
type	sasl-credentials
type	content-filtering
type	simple
source	body
name	equal
type	string
type	integer
type	double
type	boolean
type	literal
type	reference
value	USER_ID
value	CLIENT_ID

application/json (V1 API)

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique option ID.
» owner	string	true	none	Option owner.
» organization	string	true	none	Organization this option belongs to.
» eventSourceId	string	true	none	Source topic that this option belongs to.
» alias	string	true	none	Unique, descriptive alias for this option.
» name	string	true	none	Descriptive name for this option.
» description	string	false	none	Longer description used to describe what this option is used for.
» gatewayGroups	[string]	true	none	List of gateway groups this option should be published to.
» hidden	boolean	true	none	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this option is visible in the catalog.
» allowSubscriptions	boolean	true	none	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this option is allowing new subscriptions.
» catalogs	[object]	false	none	List of catalogs to which the option is published.
»» id	string	true	none	Unique catalog ID.
»» state	string	false	none	Indicates if this option is published, unpublished or archived.
» controls	[anyOf]	true	none	Controls on this virtual topic.

anyOf

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» requests	[object]	true	none	none
»»»» id	string	true	none	Unique approval request ID.
»»»» owner	string	true	none	Approval request owner.
»»»» lastUpdated	integer	false	none	Unix Epoch timestamp of last update to approval request.
»»»» status	string	true	none	The status of this approval request.
»»»» description	string	true	none	Description of why the request was created.
»»»» contact	string	true	none	Contact details of the person making the request.
»»»» outcome	string	false	none	Description of the outcome of this request.
»»»» subscriptionId	string	false	none	The id of the subscription associated with this request.
»»»» applicationId	string	false	none	The id of the application associated with this request.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» redactions	[anyOf]	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	Type of redaction.
»»»»»» replaceWith	string	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	any	true	none	Type of redaction.
»»»»»» replaceWith	number	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	Type of redaction.
»»»»»» algorithm	string	true	none	Algorithm to use for hashing the current value.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» schema	object	true	none	none
»»»» filtered	boolean	true	none	If true, any schema associated with the source topic will be used to filter records sent to applications.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	false	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	false	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»» anonymous	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» trustPem	string	true	none	Certificate Authority in PEM format.

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.
»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

and

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» identificationType	string	false	none	The type of identification users will use to distinguish between subscriptions. Defaults to MTLS when not provided.
»»»» identificationSubjectFields	[string]	false	none	Certificate subject fields to identify users by if using MTLS identificationType.
»»»» subjectCommonName	string	true	none	Subject Common Name to match on.
»»»» subjectOrganization	string	false	none	Subject Organization to match on.
»»»» subjectCountry	string	false	none	Subject Country to match on.
»»»» subjectStateOrProvince	string	false	none	Subject Region to match on.
»»»» subjectLocality	string	false	none	Subject Locality to match on.
»»»» approvedCipherSuites	[string]	false	none	Cipher suites that are approved for use.
»»»» disapprovedCipherSuites	[string]	false	none	Cipher suites that are not approved for use.
»»»» notValidBefore	integer	false	none	Certificate not valid before time.
»»»» notValidAfter	integer	false	none	Certificate not valid after time.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» filterCondition	object	true	none	none
»»»» type	string	true	none	none
»»»» eventProperty	object	true	none	none
»»»»» path	string	true	none	JSONPath to the field.
»»»»» source	string	true	none	Location of the property in the event.
»»»» operator	object	true	none	none
»»»»» name	string	true	none	none
»»»»» type	string	true	none	none
»»»» value	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	none
»»»»»» value	any	true	none	Literal comparison value.

oneOf

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	string	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	number	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	boolean	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	none
»»»»»» value	string	true	none	Reference to a Kafka connection metadata property.

continued

Name	Type	Required	Restrictions	Description
» groupVisibility	[string]	true	none	List of groups this option should be visible to in the catalog.

Enumerated Values

Property	Value
state	published
state	unpublished
state	archived
type	approval
status	pending
status	approved
status	rejected
status	fulfilled
type	redaction
type	replaceString
type	replaceIntegral
type	replaceDouble
type	hash
algorithm	SHA-256
algorithm	SHA-512
type	schema-filtering
type	quota
type	mtls
identificationType	MTLS
identificationType	SASL
type	content-filtering
type	simple
source	body
name	equal
type	string
type	integer
type	double
type	boolean
type	literal
type	reference
value	USER_ID
value	CLIENT_ID

updateOption

Code samples

# You can also use wget
curl -X PUT /admin/options/{optionId} \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT /options/{optionId}

Update an option. This endpoint is now deprecated. Use /virtualtopics/{virtualTopicId} endpoint instead.

Body parameter

{
  "eventSourceId": "string",
  "alias": "string",
  "name": "string",
  "description": "string",
  "gatewayGroups": [
    "string"
  ],
  "catalogs": [
    {
      "id": "string",
      "state": "published"
    }
  ],
  "hidden": true,
  "allowSubscriptions": true,
  "controls": [
    {
      "id": "string",
      "type": "approval",
      "requests": [
        {
          "id": "string",
          "owner": "string",
          "lastUpdated": 0,
          "status": "pending",
          "description": "string",
          "contact": "string",
          "outcome": "string",
          "subscriptionId": "string",
          "applicationId": "string"
        }
      ]
    }
  ],
  "groupVisibility": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
optionId	path	string	true	The ID of the option to update.
body	body	object	true	Option data.
» eventSourceId	body	string	true	Source topic that this option belongs to.
» alias	body	string	true	Unique, descriptive alias for this option.
» name	body	string	true	Descriptive name for this option.
» description	body	string	false	Longer description used to describe what this option is used for.
» gatewayGroups	body	[string]	true	List of gateway groups this option should be published to.
» catalogs	body	[object]	false	List of catalogs to which the option is published.
»» id	body	string	true	Unique catalog ID.
»» state	body	string	false	Indicates if this option is published, unpublished or archived.
» hidden	body	boolean	true	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this option is visible in the catalog.
» allowSubscriptions	body	boolean	true	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this option is allowing new subscriptions.
» controls	body	[anyOf]	true	Controls on this virtual topic.
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»»» requests	body	[object]	true	none
»»»» id	body	string	true	Unique approval request ID.
»»»» owner	body	string	true	Approval request owner.
»»»» lastUpdated	body	integer	false	Unix Epoch timestamp of last update to approval request.
»»»» status	body	string	true	The status of this approval request.
»»»» description	body	string	true	Description of why the request was created.
»»»» contact	body	string	true	Contact details of the person making the request.
»»»» outcome	body	string	false	Description of the outcome of this request.
»»»» subscriptionId	body	string	false	The id of the subscription associated with this request.
»»»» applicationId	body	string	false	The id of the application associated with this request.
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»»» redactions	body	[anyOf]	true	none
»»»» anonymous	body	any	false	none
»»»»» anonymous	body	object	false	none
»»»»»» path	body	string	true	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).
»»»»» anonymous	body	object	false	none
»»»»»» type	body	string	true	Type of redaction.
»»»»»» replaceWith	body	string	true	The value to replace with.
»»»» anonymous	body	any	false	none
»»»»» anonymous	body	object	false	none
»»»»»» path	body	string	true	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).
»»»»» anonymous	body	object	false	none
»»»»»» type	body	any	true	Type of redaction.
»»»»»» replaceWith	body	number	true	The value to replace with.
»»»» anonymous	body	any	false	none
»»»»» anonymous	body	object	false	none
»»»»»» path	body	string	true	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).
»»»»» anonymous	body	object	false	none
»»»»»» type	body	string	true	Type of redaction.
»»»»»» algorithm	body	string	true	Algorithm to use for hashing the current value.
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»»» schema	body	object	true	none
»»»» filtered	body	boolean	true	If true, any schema associated with the source topic will be used to filter records sent to applications.
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»»» anonymous	body	object	false	none
»»»» megabytesPerSecond	body	number	true	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	body	number	false	Upper limit to messages per second produced/consumed.
»»» anonymous	body	object	false	none
»»»» megabytesPerSecond	body	number	false	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	body	number	true	Upper limit to messages per second produced/consumed.
»»» anonymous	body	object	false	none
»»»» megabytesPerSecond	body	number	true	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	body	number	true	Upper limit to messages per second produced/consumed.
»» anonymous	body	any	false	none
»»» anonymous	body	any	false	none
»»»» anonymous	body	object	false	none
»»»»» trustPem	body	string	true	Certificate Authority in PEM format.
»»»» anonymous	body	any	false	none
»»»»» anonymous	body	object	false	none
»»»»»» acceptProfileCa	body	boolean	true	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.
»»»»» anonymous	body	object	false	none
»»»»»» acceptOrgCa	body	boolean	true	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.
»»»»» anonymous	body	object	false	none
»»»»»» acceptProfileCa	body	boolean	true	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.
»»»»»» acceptOrgCa	body	boolean	true	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.
»»» anonymous	body	object	false	none
»»»» id	body	string	true	Unique control ID.
»»»» type	body	string	true	none
»»»» identificationType	body	string	false	The type of identification users will use to distinguish between subscriptions. Defaults to MTLS when not provided.
»»»» identificationSubjectFields	body	[string]	false	Certificate subject fields to identify users by if using MTLS identificationType.
»»»» subjectCommonName	body	string	true	Subject Common Name to match on.
»»»» subjectOrganization	body	string	false	Subject Organization to match on.
»»»» subjectCountry	body	string	false	Subject Country to match on.
»»»» subjectStateOrProvince	body	string	false	Subject Region to match on.
»»»» subjectLocality	body	string	false	Subject Locality to match on.
»»»» approvedCipherSuites	body	[string]	false	Cipher suites that are approved for use.
»»»» disapprovedCipherSuites	body	[string]	false	Cipher suites that are not approved for use.
»»»» notValidBefore	body	integer	false	Certificate not valid before time.
»»»» notValidAfter	body	integer	false	Certificate not valid after time.
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»»» filterCondition	body	object	true	none
»»»» type	body	string	true	none
»»»» eventProperty	body	object	true	none
»»»»» path	body	string	true	JSONPath to the field.
»»»»» source	body	string	true	Location of the property in the event.
»»»» operator	body	object	true	none
»»»»» name	body	string	true	none
»»»»» type	body	string	true	none
»»»» value	body	any	true	none
»»»»» anonymous	body	object	false	none
»»»»»» type	body	string	true	none
»»»»»» value	body	any	true	Literal comparison value.
»»»»»»» anonymous	body	string	false	none
»»»»»»» anonymous	body	number	false	none
»»»»»»» anonymous	body	boolean	false	none
»»»»» anonymous	body	object	false	none
»»»»»» type	body	string	true	none
»»»»»» value	body	string	true	Reference to a Kafka connection metadata property.
» groupVisibility	body	[string]	false	List of groups this option should be visible to in the catalog.

Enumerated Values

Parameter	Value
»» state	published
»» state	unpublished
»» state	archived
»»» type	approval
»»»» status	pending
»»»» status	approved
»»»» status	rejected
»»»» status	fulfilled
»»» type	redaction
»»»»»» type	replaceString
»»»»»» type	replaceIntegral
»»»»»» type	replaceDouble
»»»»»» type	hash
»»»»»» algorithm	SHA-256
»»»»»» algorithm	SHA-512
»»» type	schema-filtering
»»» type	quota
»»»» type	mtls
»»»» identificationType	MTLS
»»»» identificationType	SASL
»»»» identificationSubjectFields	subjectCommonName
»»»» identificationSubjectFields	subjectOrganization
»»»» identificationSubjectFields	subjectCountry
»»»» identificationSubjectFields	subjectStateOrProvince
»»»» identificationSubjectFields	subjectLocality
»»» type	sasl-oauth
»»» type	sasl-credentials
»»» type	content-filtering
»»»» type	simple
»»»»» source	body
»»»»» name	equal
»»»»» type	string
»»»»» type	integer
»»»»» type	double
»»»»» type	boolean
»»»»»» type	literal
»»»»»» type	reference
»»»»»» value	USER_ID
»»»»»» value	CLIENT_ID

Responses

Status	Meaning	Description	Schema
200	OK	Option successfully updated.	None
400	Bad Request	Invalid request, request data does not match schema or Controls specified not compatible with gateway group.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	This option does not exist.	None
500	Internal Server Error	Internal error.	None

deleteOption

Code samples

# You can also use wget
curl -X DELETE /admin/options/{optionId} \
  -H 'Authorization: Bearer {access-token}'

DELETE /options/{optionId}

Delete an option. This endpoint is now deprecated. Use /virtualtopics/{virtualTopicId} endpoint instead.

Parameters

Name	In	Type	Required	Description
optionId	path	string	true	The ID of the option to delete.

Responses

Status	Meaning	Description	Schema
200	OK	Option successfully deleted.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	This option does not exist.	None
409	Conflict	Option could not be deleted due to a conflict.	None
500	Internal Server Error	Internal error.	None

exportAPICAsyncAPI

Code samples

# You can also use wget
curl -X GET /admin/options/{optionId}/apicasyncapi \
  -H 'Accept: application/yaml' \
  -H 'Authorization: Bearer {access-token}'

GET /options/{optionId}/apicasyncapi

Generate an AsyncAPI document for a selected option with connections added for IBM API Connect. This endpoint is now deprecated. Use /virtualtopics/{virtualTopicId}/apicasyncapi endpoint instead.

Parameters

Name	In	Type	Required	Description
optionId	path	string	true	The ID of the option in the source topic.
version	query	string	false	The version of AsyncAPI.

Example responses

200 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	AsyncAPI successfully generated.	string
400	Bad Request	Bad input.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	Option not found.	None
422	Unprocessable Entity	Cannot export option with approval control.	None
500	Internal Server Error	Internal error.	None

exportAsyncAPI

Code samples

# You can also use wget
curl -X GET /admin/options/{optionId}/asyncapi \
  -H 'Accept: application/yaml' \
  -H 'Authorization: Bearer {access-token}'

GET /options/{optionId}/asyncapi

Generate an AsyncAPI document for a selected option. This endpoint is now deprecated. Use /virtualtopics/{virtualTopicId}/asyncapi endpoint instead.

Parameters

Name	In	Type	Required	Description
optionId	path	string	true	The ID of the option in the source topic.
version	query	string	false	The version of AsyncAPI

Example responses

200 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	AsyncAPI successfully generated.	string
400	Bad Request	Bad input.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	Option not found.	None
500	Internal Server Error	Internal error.	None

readAllVirtualTopics

Code samples

# You can also use wget
curl -X GET /admin/virtualtopics \
  -H 'Accept: application/vnd.ibm.eem.v2+json' \
  -H 'Authorization: Bearer {access-token}'

GET /virtualtopics

List all virtual topics created by the current user in an organization. To view all virtual topics with 11.7.1 or later controls, you must specify the header ‘Accept: application/vnd.ibm.eem.v2+json’. If you omit the header or specify ‘application/json’, then the response includes only virtual topics that can be represented with 11.7.0 or earlier controls.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The page number of results to retrieve. If this number exceeds the available data, then the last page is returned.
maxPageSize	query	integer	false	The maximum number of entries to return per page. If not specified, all data items are returned.

Example responses

200 Response

application/vnd.ibm.eem.v2+json

[
  {
    "id": "string",
    "owner": "string",
    "organization": "string",
    "sourceTopicId": "string",
    "alias": "string",
    "name": "string",
    "description": "string",
    "gatewayGroups": [
      "string"
    ],
    "catalogs": [
      {
        "id": "string",
        "state": "published"
      }
    ],
    "hidden": true,
    "allowSubscriptions": true,
    "controls": [
      {
        "id": "string",
        "type": "approval",
        "requests": [
          {
            "id": "string",
            "owner": "string",
            "lastUpdated": 0,
            "status": "pending",
            "description": "string",
            "contact": "string",
            "outcome": "string",
            "subscriptionId": "string",
            "applicationId": "string"
          }
        ]
      }
    ],
    "groupVisibility": [
      "string"
    ]
  }
]

application/json

[
  {
    "id": "string",
    "owner": "string",
    "organization": "string",
    "sourceTopicId": "string",
    "alias": "string",
    "name": "string",
    "description": "string",
    "gatewayGroups": [
      "string"
    ],
    "catalogs": [
      {
        "id": "string",
        "state": "published"
      }
    ],
    "hidden": true,
    "allowSubscriptions": true,
    "controls": [
      {
        "id": "string",
        "type": "approval",
        "requests": [
          {
            "id": "string",
            "owner": "string",
            "lastUpdated": 0,
            "status": "pending",
            "description": "string",
            "contact": "string",
            "outcome": "string",
            "subscriptionId": "string",
            "applicationId": "string"
          }
        ]
      }
    ],
    "groupVisibility": [
      "string"
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Virtual topics successfully listed.	Inline
304	Not Modified	Data not changed.	None
400	Bad Request	Invalid request, only one of page and maxPageSize were supplied or max page size exceeded.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
406	Not Acceptable	Not Acceptable. The requested media type is not supported.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

application/vnd.ibm.eem.v2+json (V2 API)

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique Virtual Topic ID.
» owner	string	true	none	Virtual Topic owner.
» organization	string	true	none	Organization this Virtual Topic belongs to.
» sourceTopicId	string	true	none	Source topic that this virtual topic belongs to
» alias	string	true	none	Unique, descriptive alias for this virtual topic
» name	string	true	none	Descriptive name for this virtual topic
» description	string	false	none	Longer description used to describe what this virtual topic is used for
» gatewayGroups	[string]	true	none	List of gateway groups this virtual topic should be published to
» catalogs	[object]	false	none	List of catalogs to which the virtual topic is published
»» id	string	true	none	Unique catalog ID.
»» state	string	false	none	Indicates if this virtual topic is published, unpublished or archived
» hidden	boolean	true	none	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this virtual topic is visible in the catalog
» allowSubscriptions	boolean	true	none	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this virtual topic is allowing new subscriptions
» controls	[anyOf]	true	none	Controls on this virtual topic.

anyOf

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» requests	[object]	true	none	none
»»»» id	string	true	none	Unique approval request ID.
»»»» owner	string	true	none	Approval request owner.
»»»» lastUpdated	integer	false	none	Unix Epoch timestamp of last update to approval request.
»»»» status	string	true	none	The status of this approval request.
»»»» description	string	true	none	Description of why the request was created.
»»»» contact	string	true	none	Contact details of the person making the request.
»»»» outcome	string	false	none	Description of the outcome of this request.
»»»» subscriptionId	string	false	none	The id of the subscription associated with this request.
»»»» applicationId	string	false	none	The id of the application associated with this request.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» redactions	[anyOf]	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	Type of redaction.
»»»»»» replaceWith	string	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	any	true	none	Type of redaction.
»»»»»» replaceWith	number	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	Type of redaction.
»»»»»» algorithm	string	true	none	Algorithm to use for hashing the current value.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» schema	object	true	none	none
»»»» filtered	boolean	true	none	If true, any schema associated with the source topic will be used to filter records sent to applications.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	false	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	false	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»» anonymous	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» trustPem	string	true	none	Certificate Authority in PEM format.

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.
»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

and

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» identificationType	string	false	none	The type of identification users will use to distinguish between subscriptions. Defaults to MTLS when not provided.
»»»» identificationSubjectFields	[string]	false	none	Certificate subject fields to identify users by if using MTLS identificationType.
»»»» subjectCommonName	string	true	none	Subject Common Name to match on.
»»»» subjectOrganization	string	false	none	Subject Organization to match on.
»»»» subjectCountry	string	false	none	Subject Country to match on.
»»»» subjectStateOrProvince	string	false	none	Subject Region to match on.
»»»» subjectLocality	string	false	none	Subject Locality to match on.
»»»» approvedCipherSuites	[string]	false	none	Cipher suites that are approved for use.
»»»» disapprovedCipherSuites	[string]	false	none	Cipher suites that are not approved for use.
»»»» notValidBefore	integer	false	none	Certificate not valid before time.
»»»» notValidAfter	integer	false	none	Certificate not valid after time.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» filterCondition	object	true	none	none
»»»» type	string	true	none	none
»»»» eventProperty	object	true	none	none
»»»»» path	string	true	none	JSONPath to the field.
»»»»» source	string	true	none	Location of the property in the event.
»»»» operator	object	true	none	none
»»»»» name	string	true	none	none
»»»»» type	string	true	none	none
»»»» value	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	none
»»»»»» value	any	true	none	Literal comparison value.

oneOf

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	string	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	number	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	boolean	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	none
»»»»»» value	string	true	none	Reference to a Kafka connection metadata property.

continued

Name	Type	Required	Restrictions	Description
» groupVisibility	[string]	true	none	List of groups this virtual topic should be visible to in the catalog

Enumerated Values

Property	Value
state	published
state	unpublished
state	archived
type	approval
status	pending
status	approved
status	rejected
status	fulfilled
type	redaction
type	replaceString
type	replaceIntegral
type	replaceDouble
type	hash
algorithm	SHA-256
algorithm	SHA-512
type	schema-filtering
type	quota
type	mtls
identificationType	MTLS
identificationType	SASL
type	sasl-oauth
type	sasl-credentials
type	content-filtering
type	simple
source	body
name	equal
type	string
type	integer
type	double
type	boolean
type	literal
type	reference
value	USER_ID
value	CLIENT_ID

application/json (V1 API)

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique Virtual Topic ID.
» owner	string	true	none	Virtual Topic owner.
» organization	string	true	none	Organization this Virtual Topic belongs to.
» sourceTopicId	string	true	none	Source topic that this virtual topic belongs to
» alias	string	true	none	Unique, descriptive alias for this virtual topic
» name	string	true	none	Descriptive name for this virtual topic
» description	string	false	none	Longer description used to describe what this virtual topic is used for
» gatewayGroups	[string]	true	none	List of gateway groups this virtual topic should be published to
» catalogs	[object]	false	none	List of catalogs to which the virtual topic is published
»» id	string	true	none	Unique catalog ID.
»» state	string	false	none	Indicates if this virtual topic is published, unpublished or archived
» hidden	boolean	true	none	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this virtual topic is visible in the catalog
» allowSubscriptions	boolean	true	none	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this virtual topic is allowing new subscriptions
» controls	[anyOf]	true	none	Controls on this virtual topic.

anyOf

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» requests	[object]	true	none	none
»»»» id	string	true	none	Unique approval request ID.
»»»» owner	string	true	none	Approval request owner.
»»»» lastUpdated	integer	false	none	Unix Epoch timestamp of last update to approval request.
»»»» status	string	true	none	The status of this approval request.
»»»» description	string	true	none	Description of why the request was created.
»»»» contact	string	true	none	Contact details of the person making the request.
»»»» outcome	string	false	none	Description of the outcome of this request.
»»»» subscriptionId	string	false	none	The id of the subscription associated with this request.
»»»» applicationId	string	false	none	The id of the application associated with this request.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» redactions	[anyOf]	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	Type of redaction.
»»»»»» replaceWith	string	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	any	true	none	Type of redaction.
»»»»»» replaceWith	number	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	Type of redaction.
»»»»»» algorithm	string	true	none	Algorithm to use for hashing the current value.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» schema	object	true	none	none
»»»» filtered	boolean	true	none	If true, any schema associated with the source topic will be used to filter records sent to applications.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	false	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	false	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»» anonymous	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» trustPem	string	true	none	Certificate Authority in PEM format.

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.
»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

and

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» identificationType	string	false	none	The type of identification users will use to distinguish between subscriptions. Defaults to MTLS when not provided.
»»»» identificationSubjectFields	[string]	false	none	Certificate subject fields to identify users by if using MTLS identificationType.
»»»» subjectCommonName	string	true	none	Subject Common Name to match on.
»»»» subjectOrganization	string	false	none	Subject Organization to match on.
»»»» subjectCountry	string	false	none	Subject Country to match on.
»»»» subjectStateOrProvince	string	false	none	Subject Region to match on.
»»»» subjectLocality	string	false	none	Subject Locality to match on.
»»»» approvedCipherSuites	[string]	false	none	Cipher suites that are approved for use.
»»»» disapprovedCipherSuites	[string]	false	none	Cipher suites that are not approved for use.
»»»» notValidBefore	integer	false	none	Certificate not valid before time.
»»»» notValidAfter	integer	false	none	Certificate not valid after time.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» filterCondition	object	true	none	none
»»»» type	string	true	none	none
»»»» eventProperty	object	true	none	none
»»»»» path	string	true	none	JSONPath to the field.
»»»»» source	string	true	none	Location of the property in the event.
»»»» operator	object	true	none	none
»»»»» name	string	true	none	none
»»»»» type	string	true	none	none
»»»» value	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	none
»»»»»» value	any	true	none	Literal comparison value.

oneOf

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	string	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	number	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	boolean	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	none
»»»»»» value	string	true	none	Reference to a Kafka connection metadata property.

continued

Name	Type	Required	Restrictions	Description
» groupVisibility	[string]	true	none	List of groups this virtual topic should be visible to in the catalog

Enumerated Values

Property	Value
state	published
state	unpublished
state	archived
type	approval
status	pending
status	approved
status	rejected
status	fulfilled
type	redaction
type	replaceString
type	replaceIntegral
type	replaceDouble
type	hash
algorithm	SHA-256
algorithm	SHA-512
type	schema-filtering
type	quota
type	mtls
identificationType	MTLS
identificationType	SASL
type	sasl-oauth
type	sasl-credentials
type	content-filtering
type	simple
source	body
name	equal
type	string
type	integer
type	double
type	boolean
type	literal
type	reference
value	USER_ID
value	CLIENT_ID

Response Headers

Status	Header	Type	Format	Description
200	ei-pagination-total	integer		Total number of items available for retrieval (including current page).
200	etag	string		An identifier that can be supplied with the If-None-Match header to indicate that unchanged results should return 304 with no data.

createVirtualTopic

Code samples

# You can also use wget
curl -X POST /admin/virtualtopics \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /virtualtopics

Create a virtual topic.

Body parameter

{
  "sourceTopicId": "string",
  "alias": "string",
  "name": "string",
  "description": "string",
  "gatewayGroups": [
    "string"
  ],
  "catalogs": [
    {
      "id": "string",
      "state": "published"
    }
  ],
  "hidden": true,
  "allowSubscriptions": true,
  "controls": [
    {
      "id": "string",
      "type": "approval",
      "requests": [
        {
          "id": "string",
          "owner": "string",
          "lastUpdated": 0,
          "status": "pending",
          "description": "string",
          "contact": "string",
          "outcome": "string",
          "subscriptionId": "string",
          "applicationId": "string"
        }
      ]
    }
  ],
  "groupVisibility": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	Virtual topic data.
» sourceTopicId	body	string	true	Source topic that this virtual topic belongs to
» alias	body	string	true	Unique, descriptive alias for this virtual topic
» name	body	string	true	Descriptive name for this virtual topic
» description	body	string	false	Longer description used to describe what this virtual topic is used for
» gatewayGroups	body	[string]	true	List of gateway groups this virtual topic should be published to
» catalogs	body	[object]	false	List of catalogs to which the virtual topic is published
»» id	body	string	true	Unique catalog ID.
»» state	body	string	false	Indicates if this virtual topic is published, unpublished or archived
» hidden	body	boolean	true	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this virtual topic is visible in the catalog
» allowSubscriptions	body	boolean	true	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this virtual topic is allowing new subscriptions
» controls	body	[anyOf]	true	Controls on this virtual topic.
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»»» requests	body	[object]	true	none
»»»» id	body	string	true	Unique approval request ID.
»»»» owner	body	string	true	Approval request owner.
»»»» lastUpdated	body	integer	false	Unix Epoch timestamp of last update to approval request.
»»»» status	body	string	true	The status of this approval request.
»»»» description	body	string	true	Description of why the request was created.
»»»» contact	body	string	true	Contact details of the person making the request.
»»»» outcome	body	string	false	Description of the outcome of this request.
»»»» subscriptionId	body	string	false	The id of the subscription associated with this request.
»»»» applicationId	body	string	false	The id of the application associated with this request.
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»»» redactions	body	[anyOf]	true	none
»»»» anonymous	body	any	false	none
»»»»» anonymous	body	object	false	none
»»»»»» path	body	string	true	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).
»»»»» anonymous	body	object	false	none
»»»»»» type	body	string	true	Type of redaction.
»»»»»» replaceWith	body	string	true	The value to replace with.
»»»» anonymous	body	any	false	none
»»»»» anonymous	body	object	false	none
»»»»»» path	body	string	true	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).
»»»»» anonymous	body	object	false	none
»»»»»» type	body	any	true	Type of redaction.
»»»»»» replaceWith	body	number	true	The value to replace with.
»»»» anonymous	body	any	false	none
»»»»» anonymous	body	object	false	none
»»»»»» path	body	string	true	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).
»»»»» anonymous	body	object	false	none
»»»»»» type	body	string	true	Type of redaction.
»»»»»» algorithm	body	string	true	Algorithm to use for hashing the current value.
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»»» schema	body	object	true	none
»»»» filtered	body	boolean	true	If true, any schema associated with the source topic will be used to filter records sent to applications.
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»»» anonymous	body	object	false	none
»»»» megabytesPerSecond	body	number	true	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	body	number	false	Upper limit to messages per second produced/consumed.
»»» anonymous	body	object	false	none
»»»» megabytesPerSecond	body	number	false	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	body	number	true	Upper limit to messages per second produced/consumed.
»»» anonymous	body	object	false	none
»»»» megabytesPerSecond	body	number	true	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	body	number	true	Upper limit to messages per second produced/consumed.
»» anonymous	body	any	false	none
»»» anonymous	body	any	false	none
»»»» anonymous	body	object	false	none
»»»»» trustPem	body	string	true	Certificate Authority in PEM format.
»»»» anonymous	body	any	false	none
»»»»» anonymous	body	object	false	none
»»»»»» acceptProfileCa	body	boolean	true	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.
»»»»» anonymous	body	object	false	none
»»»»»» acceptOrgCa	body	boolean	true	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.
»»»»» anonymous	body	object	false	none
»»»»»» acceptProfileCa	body	boolean	true	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.
»»»»»» acceptOrgCa	body	boolean	true	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.
»»» anonymous	body	object	false	none
»»»» id	body	string	true	Unique control ID.
»»»» type	body	string	true	none
»»»» identificationType	body	string	false	The type of identification users will use to distinguish between subscriptions. Defaults to MTLS when not provided.
»»»» identificationSubjectFields	body	[string]	false	Certificate subject fields to identify users by if using MTLS identificationType.
»»»» subjectCommonName	body	string	true	Subject Common Name to match on.
»»»» subjectOrganization	body	string	false	Subject Organization to match on.
»»»» subjectCountry	body	string	false	Subject Country to match on.
»»»» subjectStateOrProvince	body	string	false	Subject Region to match on.
»»»» subjectLocality	body	string	false	Subject Locality to match on.
»»»» approvedCipherSuites	body	[string]	false	Cipher suites that are approved for use.
»»»» disapprovedCipherSuites	body	[string]	false	Cipher suites that are not approved for use.
»»»» notValidBefore	body	integer	false	Certificate not valid before time.
»»»» notValidAfter	body	integer	false	Certificate not valid after time.
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»»» filterCondition	body	object	true	none
»»»» type	body	string	true	none
»»»» eventProperty	body	object	true	none
»»»»» path	body	string	true	JSONPath to the field.
»»»»» source	body	string	true	Location of the property in the event.
»»»» operator	body	object	true	none
»»»»» name	body	string	true	none
»»»»» type	body	string	true	none
»»»» value	body	any	true	none
»»»»» anonymous	body	object	false	none
»»»»»» type	body	string	true	none
»»»»»» value	body	any	true	Literal comparison value.
»»»»»»» anonymous	body	string	false	none
»»»»»»» anonymous	body	number	false	none
»»»»»»» anonymous	body	boolean	false	none
»»»»» anonymous	body	object	false	none
»»»»»» type	body	string	true	none
»»»»»» value	body	string	true	Reference to a Kafka connection metadata property.
» groupVisibility	body	[string]	false	List of groups this virtual topic should be visible to in the catalog

Enumerated Values

Parameter	Value
»» state	published
»» state	unpublished
»» state	archived
»»» type	approval
»»»» status	pending
»»»» status	approved
»»»» status	rejected
»»»» status	fulfilled
»»» type	redaction
»»»»»» type	replaceString
»»»»»» type	replaceIntegral
»»»»»» type	replaceDouble
»»»»»» type	hash
»»»»»» algorithm	SHA-256
»»»»»» algorithm	SHA-512
»»» type	schema-filtering
»»» type	quota
»»»» type	mtls
»»»» identificationType	MTLS
»»»» identificationType	SASL
»»»» identificationSubjectFields	subjectCommonName
»»»» identificationSubjectFields	subjectOrganization
»»»» identificationSubjectFields	subjectCountry
»»»» identificationSubjectFields	subjectStateOrProvince
»»»» identificationSubjectFields	subjectLocality
»»» type	sasl-oauth
»»» type	sasl-credentials
»»» type	content-filtering
»»»» type	simple
»»»»» source	body
»»»»» name	equal
»»»»» type	string
»»»»» type	integer
»»»»» type	double
»»»»» type	boolean
»»»»»» type	literal
»»»»»» type	reference
»»»»»» value	USER_ID
»»»»»» value	CLIENT_ID

Example responses

200 Response

{
  "id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The ID of the created virtual topic.	Inline
400	Bad Request	Invalid request, request data does not match schema or Controls specified not compatible with gateway group.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
426	Upgrade Required	Limit reached, upgrade required to your service plan.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	false	none	none

readVirtualTopic

Code samples

# You can also use wget
curl -X GET /admin/virtualtopics/{virtualTopicId} \
  -H 'Accept: application/vnd.ibm.eem.v2+json' \
  -H 'Authorization: Bearer {access-token}'

GET /virtualtopics/{virtualTopicId}

Read a virtual topic. You must specify the header ‘Accept: application/vnd.ibm.eem.v2+json’. If you omit the header or specify ‘application/json’, then the virtual topic is only returned if it can be represented with 11.7.0 or earlier controls.

Parameters

Name	In	Type	Required	Description
virtualTopicId	path	string	true	The ID of the virtual topic.

Example responses

200 Response

application/vnd.ibm.eem.v2+json

{
  "id": "string",
  "owner": "string",
  "organization": "string",
  "sourceTopicId": "string",
  "alias": "string",
  "name": "string",
  "description": "string",
  "gatewayGroups": [
    "string"
  ],
  "catalogs": [
    {
      "id": "string",
      "state": "published"
    }
  ],
  "hidden": true,
  "allowSubscriptions": true,
  "controls": [
    {
      "id": "string",
      "type": "approval",
      "requests": [
        {
          "id": "string",
          "owner": "string",
          "lastUpdated": 0,
          "status": "pending",
          "description": "string",
          "contact": "string",
          "outcome": "string",
          "subscriptionId": "string",
          "applicationId": "string"
        }
      ]
    }
  ],
  "groupVisibility": [
    "string"
  ]
}

application/json

{
  "id": "string",
  "owner": "string",
  "organization": "string",
  "sourceTopicId": "string",
  "alias": "string",
  "name": "string",
  "description": "string",
  "gatewayGroups": [
    "string"
  ],
  "catalogs": [
    {
      "id": "string",
      "state": "published"
    }
  ],
  "hidden": true,
  "allowSubscriptions": true,
  "controls": [
    {
      "id": "string",
      "type": "approval",
      "requests": [
        {
          "id": "string",
          "owner": "string",
          "lastUpdated": 0,
          "status": "pending",
          "description": "string",
          "contact": "string",
          "outcome": "string",
          "subscriptionId": "string",
          "applicationId": "string"
        }
      ]
    }
  ],
  "groupVisibility": [
    "string"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The data for the requested virtual topic.	Inline
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	This virtual topic does not exist.	None
406	Not Acceptable	Not Acceptable. The requested media type is not supported.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

application/vnd.ibm.eem.v2+json (V2 API)

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique Virtual Topic ID.
» owner	string	true	none	Virtual Topic owner.
» organization	string	true	none	Organization this Virtual Topic belongs to.
» sourceTopicId	string	true	none	Source topic that this virtual topic belongs to
» alias	string	true	none	Unique, descriptive alias for this virtual topic
» name	string	true	none	Descriptive name for this virtual topic
» description	string	false	none	Longer description used to describe what this virtual topic is used for
» gatewayGroups	[string]	true	none	List of gateway groups this virtual topic should be published to
» catalogs	[object]	false	none	List of catalogs to which the virtual topic is published
»» id	string	true	none	Unique catalog ID.
»» state	string	false	none	Indicates if this virtual topic is published, unpublished or archived
» hidden	boolean	true	none	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this virtual topic is visible in the catalog
» allowSubscriptions	boolean	true	none	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this virtual topic is allowing new subscriptions
» controls	[anyOf]	true	none	Controls on this virtual topic.

anyOf

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» requests	[object]	true	none	none
»»»» id	string	true	none	Unique approval request ID.
»»»» owner	string	true	none	Approval request owner.
»»»» lastUpdated	integer	false	none	Unix Epoch timestamp of last update to approval request.
»»»» status	string	true	none	The status of this approval request.
»»»» description	string	true	none	Description of why the request was created.
»»»» contact	string	true	none	Contact details of the person making the request.
»»»» outcome	string	false	none	Description of the outcome of this request.
»»»» subscriptionId	string	false	none	The id of the subscription associated with this request.
»»»» applicationId	string	false	none	The id of the application associated with this request.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» redactions	[anyOf]	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	Type of redaction.
»»»»»» replaceWith	string	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	any	true	none	Type of redaction.
»»»»»» replaceWith	number	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	Type of redaction.
»»»»»» algorithm	string	true	none	Algorithm to use for hashing the current value.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» schema	object	true	none	none
»»»» filtered	boolean	true	none	If true, any schema associated with the source topic will be used to filter records sent to applications.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	false	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	false	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»» anonymous	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» trustPem	string	true	none	Certificate Authority in PEM format.

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.
»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

and

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» identificationType	string	false	none	The type of identification users will use to distinguish between subscriptions. Defaults to MTLS when not provided.
»»»» identificationSubjectFields	[string]	false	none	Certificate subject fields to identify users by if using MTLS identificationType.
»»»» subjectCommonName	string	true	none	Subject Common Name to match on.
»»»» subjectOrganization	string	false	none	Subject Organization to match on.
»»»» subjectCountry	string	false	none	Subject Country to match on.
»»»» subjectStateOrProvince	string	false	none	Subject Region to match on.
»»»» subjectLocality	string	false	none	Subject Locality to match on.
»»»» approvedCipherSuites	[string]	false	none	Cipher suites that are approved for use.
»»»» disapprovedCipherSuites	[string]	false	none	Cipher suites that are not approved for use.
»»»» notValidBefore	integer	false	none	Certificate not valid before time.
»»»» notValidAfter	integer	false	none	Certificate not valid after time.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» filterCondition	object	true	none	none
»»»» type	string	true	none	none
»»»» eventProperty	object	true	none	none
»»»»» path	string	true	none	JSONPath to the field.
»»»»» source	string	true	none	Location of the property in the event.
»»»» operator	object	true	none	none
»»»»» name	string	true	none	none
»»»»» type	string	true	none	none
»»»» value	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	none
»»»»»» value	any	true	none	Literal comparison value.

oneOf

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	string	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	number	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	boolean	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	none
»»»»»» value	string	true	none	Reference to a Kafka connection metadata property.

continued

Name	Type	Required	Restrictions	Description
» groupVisibility	[string]	true	none	List of groups this virtual topic should be visible to in the catalog

Enumerated Values

Property	Value
state	published
state	unpublished
state	archived
type	approval
status	pending
status	approved
status	rejected
status	fulfilled
type	redaction
type	replaceString
type	replaceIntegral
type	replaceDouble
type	hash
algorithm	SHA-256
algorithm	SHA-512
type	schema-filtering
type	quota
type	mtls
identificationType	MTLS
identificationType	SASL
type	sasl-oauth
type	sasl-credentials
type	content-filtering
type	simple
source	body
name	equal
type	string
type	integer
type	double
type	boolean
type	literal
type	reference
value	USER_ID
value	CLIENT_ID

application/json (V1 API)

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique Virtual Topic ID.
» owner	string	true	none	Virtual Topic owner.
» organization	string	true	none	Organization this Virtual Topic belongs to.
» sourceTopicId	string	true	none	Source topic that this virtual topic belongs to
» alias	string	true	none	Unique, descriptive alias for this virtual topic
» name	string	true	none	Descriptive name for this virtual topic
» description	string	false	none	Longer description used to describe what this virtual topic is used for
» gatewayGroups	[string]	true	none	List of gateway groups this virtual topic should be published to
» catalogs	[object]	false	none	List of catalogs to which the virtual topic is published
»» id	string	true	none	Unique catalog ID.
»» state	string	false	none	Indicates if this virtual topic is published, unpublished or archived
» hidden	boolean	true	none	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this virtual topic is visible in the catalog
» allowSubscriptions	boolean	true	none	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this virtual topic is allowing new subscriptions
» controls	[anyOf]	true	none	Controls on this virtual topic.

anyOf

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» requests	[object]	true	none	none
»»»» id	string	true	none	Unique approval request ID.
»»»» owner	string	true	none	Approval request owner.
»»»» lastUpdated	integer	false	none	Unix Epoch timestamp of last update to approval request.
»»»» status	string	true	none	The status of this approval request.
»»»» description	string	true	none	Description of why the request was created.
»»»» contact	string	true	none	Contact details of the person making the request.
»»»» outcome	string	false	none	Description of the outcome of this request.
»»»» subscriptionId	string	false	none	The id of the subscription associated with this request.
»»»» applicationId	string	false	none	The id of the application associated with this request.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» redactions	[anyOf]	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	Type of redaction.
»»»»»» replaceWith	string	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	any	true	none	Type of redaction.
»»»»»» replaceWith	number	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	Type of redaction.
»»»»»» algorithm	string	true	none	Algorithm to use for hashing the current value.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» schema	object	true	none	none
»»»» filtered	boolean	true	none	If true, any schema associated with the source topic will be used to filter records sent to applications.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	false	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	false	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»» anonymous	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» trustPem	string	true	none	Certificate Authority in PEM format.

xor

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.
»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

and

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» identificationType	string	false	none	The type of identification users will use to distinguish between subscriptions. Defaults to MTLS when not provided.
»»»» identificationSubjectFields	[string]	false	none	Certificate subject fields to identify users by if using MTLS identificationType.
»»»» subjectCommonName	string	true	none	Subject Common Name to match on.
»»»» subjectOrganization	string	false	none	Subject Organization to match on.
»»»» subjectCountry	string	false	none	Subject Country to match on.
»»»» subjectStateOrProvince	string	false	none	Subject Region to match on.
»»»» subjectLocality	string	false	none	Subject Locality to match on.
»»»» approvedCipherSuites	[string]	false	none	Cipher suites that are approved for use.
»»»» disapprovedCipherSuites	[string]	false	none	Cipher suites that are not approved for use.
»»»» notValidBefore	integer	false	none	Certificate not valid before time.
»»»» notValidAfter	integer	false	none	Certificate not valid after time.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» id	string	true	none	Unique control ID.
»»» type	string	true	none	none
»»» filterCondition	object	true	none	none
»»»» type	string	true	none	none
»»»» eventProperty	object	true	none	none
»»»»» path	string	true	none	JSONPath to the field.
»»»»» source	string	true	none	Location of the property in the event.
»»»» operator	object	true	none	none
»»»»» name	string	true	none	none
»»»»» type	string	true	none	none
»»»» value	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	none
»»»»»» value	any	true	none	Literal comparison value.

oneOf

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	string	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	number	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»» anonymous	boolean	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» type	string	true	none	none
»»»»»» value	string	true	none	Reference to a Kafka connection metadata property.

continued

Name	Type	Required	Restrictions	Description
» groupVisibility	[string]	true	none	List of groups this virtual topic should be visible to in the catalog

Enumerated Values

Property	Value
state	published
state	unpublished
state	archived
type	approval
status	pending
status	approved
status	rejected
status	fulfilled
type	redaction
type	replaceString
type	replaceIntegral
type	replaceDouble
type	hash
algorithm	SHA-256
algorithm	SHA-512
type	schema-filtering
type	quota
type	mtls
identificationType	MTLS
identificationType	SASL
type	sasl-oauth
type	sasl-credentials
type	content-filtering
type	simple
source	body
name	equal
type	string
type	integer
type	double
type	boolean
type	literal
type	reference
value	USER_ID
value	CLIENT_ID

updateVirtualTopic

Code samples

# You can also use wget
curl -X PUT /admin/virtualtopics/{virtualTopicId} \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT /virtualtopics/{virtualTopicId}

Update a virtual topic.

Body parameter

{
  "sourceTopicId": "string",
  "alias": "string",
  "name": "string",
  "description": "string",
  "gatewayGroups": [
    "string"
  ],
  "catalogs": [
    {
      "id": "string",
      "state": "published"
    }
  ],
  "hidden": true,
  "allowSubscriptions": true,
  "controls": [
    {
      "id": "string",
      "type": "approval",
      "requests": [
        {
          "id": "string",
          "owner": "string",
          "lastUpdated": 0,
          "status": "pending",
          "description": "string",
          "contact": "string",
          "outcome": "string",
          "subscriptionId": "string",
          "applicationId": "string"
        }
      ]
    }
  ],
  "groupVisibility": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
virtualTopicId	path	string	true	The ID of the virtual topic.
body	body	object	true	Virtual topic data.
» sourceTopicId	body	string	true	Source topic that this virtual topic belongs to
» alias	body	string	true	Unique, descriptive alias for this virtual topic
» name	body	string	true	Descriptive name for this virtual topic
» description	body	string	false	Longer description used to describe what this virtual topic is used for
» gatewayGroups	body	[string]	true	List of gateway groups this virtual topic should be published to
» catalogs	body	[object]	false	List of catalogs to which the virtual topic is published
»» id	body	string	true	Unique catalog ID.
»» state	body	string	false	Indicates if this virtual topic is published, unpublished or archived
» hidden	body	boolean	true	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this virtual topic is visible in the catalog
» allowSubscriptions	body	boolean	true	(Deprecated) Use catalogs[‘eem-catalog’].state instead. Indicates if this virtual topic is allowing new subscriptions
» controls	body	[anyOf]	true	Controls on this virtual topic.
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»»» requests	body	[object]	true	none
»»»» id	body	string	true	Unique approval request ID.
»»»» owner	body	string	true	Approval request owner.
»»»» lastUpdated	body	integer	false	Unix Epoch timestamp of last update to approval request.
»»»» status	body	string	true	The status of this approval request.
»»»» description	body	string	true	Description of why the request was created.
»»»» contact	body	string	true	Contact details of the person making the request.
»»»» outcome	body	string	false	Description of the outcome of this request.
»»»» subscriptionId	body	string	false	The id of the subscription associated with this request.
»»»» applicationId	body	string	false	The id of the application associated with this request.
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»»» redactions	body	[anyOf]	true	none
»»»» anonymous	body	any	false	none
»»»»» anonymous	body	object	false	none
»»»»»» path	body	string	true	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).
»»»»» anonymous	body	object	false	none
»»»»»» type	body	string	true	Type of redaction.
»»»»»» replaceWith	body	string	true	The value to replace with.
»»»» anonymous	body	any	false	none
»»»»» anonymous	body	object	false	none
»»»»»» path	body	string	true	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).
»»»»» anonymous	body	object	false	none
»»»»»» type	body	any	true	Type of redaction.
»»»»»» replaceWith	body	number	true	The value to replace with.
»»»» anonymous	body	any	false	none
»»»»» anonymous	body	object	false	none
»»»»»» path	body	string	true	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).
»»»»» anonymous	body	object	false	none
»»»»»» type	body	string	true	Type of redaction.
»»»»»» algorithm	body	string	true	Algorithm to use for hashing the current value.
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»»» schema	body	object	true	none
»»»» filtered	body	boolean	true	If true, any schema associated with the source topic will be used to filter records sent to applications.
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»»» anonymous	body	object	false	none
»»»» megabytesPerSecond	body	number	true	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	body	number	false	Upper limit to messages per second produced/consumed.
»»» anonymous	body	object	false	none
»»»» megabytesPerSecond	body	number	false	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	body	number	true	Upper limit to messages per second produced/consumed.
»»» anonymous	body	object	false	none
»»»» megabytesPerSecond	body	number	true	Upper limit to megabytes per second produced/consumed.
»»»» messagesPerSecond	body	number	true	Upper limit to messages per second produced/consumed.
»» anonymous	body	any	false	none
»»» anonymous	body	any	false	none
»»»» anonymous	body	object	false	none
»»»»» trustPem	body	string	true	Certificate Authority in PEM format.
»»»» anonymous	body	any	false	none
»»»»» anonymous	body	object	false	none
»»»»»» acceptProfileCa	body	boolean	true	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.
»»»»» anonymous	body	object	false	none
»»»»»» acceptOrgCa	body	boolean	true	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.
»»»»» anonymous	body	object	false	none
»»»»»» acceptProfileCa	body	boolean	true	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.
»»»»»» acceptOrgCa	body	boolean	true	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.
»»» anonymous	body	object	false	none
»»»» id	body	string	true	Unique control ID.
»»»» type	body	string	true	none
»»»» identificationType	body	string	false	The type of identification users will use to distinguish between subscriptions. Defaults to MTLS when not provided.
»»»» identificationSubjectFields	body	[string]	false	Certificate subject fields to identify users by if using MTLS identificationType.
»»»» subjectCommonName	body	string	true	Subject Common Name to match on.
»»»» subjectOrganization	body	string	false	Subject Organization to match on.
»»»» subjectCountry	body	string	false	Subject Country to match on.
»»»» subjectStateOrProvince	body	string	false	Subject Region to match on.
»»»» subjectLocality	body	string	false	Subject Locality to match on.
»»»» approvedCipherSuites	body	[string]	false	Cipher suites that are approved for use.
»»»» disapprovedCipherSuites	body	[string]	false	Cipher suites that are not approved for use.
»»»» notValidBefore	body	integer	false	Certificate not valid before time.
»»»» notValidAfter	body	integer	false	Certificate not valid after time.
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»» anonymous	body	object	false	none
»»» id	body	string	true	Unique control ID.
»»» type	body	string	true	none
»»» filterCondition	body	object	true	none
»»»» type	body	string	true	none
»»»» eventProperty	body	object	true	none
»»»»» path	body	string	true	JSONPath to the field.
»»»»» source	body	string	true	Location of the property in the event.
»»»» operator	body	object	true	none
»»»»» name	body	string	true	none
»»»»» type	body	string	true	none
»»»» value	body	any	true	none
»»»»» anonymous	body	object	false	none
»»»»»» type	body	string	true	none
»»»»»» value	body	any	true	Literal comparison value.
»»»»»»» anonymous	body	string	false	none
»»»»»»» anonymous	body	number	false	none
»»»»»»» anonymous	body	boolean	false	none
»»»»» anonymous	body	object	false	none
»»»»»» type	body	string	true	none
»»»»»» value	body	string	true	Reference to a Kafka connection metadata property.
» groupVisibility	body	[string]	false	List of groups this virtual topic should be visible to in the catalog

Enumerated Values

Parameter	Value
»» state	published
»» state	unpublished
»» state	archived
»»» type	approval
»»»» status	pending
»»»» status	approved
»»»» status	rejected
»»»» status	fulfilled
»»» type	redaction
»»»»»» type	replaceString
»»»»»» type	replaceIntegral
»»»»»» type	replaceDouble
»»»»»» type	hash
»»»»»» algorithm	SHA-256
»»»»»» algorithm	SHA-512
»»» type	schema-filtering
»»» type	quota
»»»» type	mtls
»»»» identificationType	MTLS
»»»» identificationType	SASL
»»»» identificationSubjectFields	subjectCommonName
»»»» identificationSubjectFields	subjectOrganization
»»»» identificationSubjectFields	subjectCountry
»»»» identificationSubjectFields	subjectStateOrProvince
»»»» identificationSubjectFields	subjectLocality
»»» type	sasl-oauth
»»» type	sasl-credentials
»»» type	content-filtering
»»»» type	simple
»»»»» source	body
»»»»» name	equal
»»»»» type	string
»»»»» type	integer
»»»»» type	double
»»»»» type	boolean
»»»»»» type	literal
»»»»»» type	reference
»»»»»» value	USER_ID
»»»»»» value	CLIENT_ID

Responses

Status	Meaning	Description	Schema
200	OK	Virtual topic successfully updated.	None
400	Bad Request	Invalid request, request data does not match schema or Controls specified not compatible with gateway group.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	This virtual topic does not exist.	None
500	Internal Server Error	Internal error.	None

deleteVirtualTopic

Code samples

# You can also use wget
curl -X DELETE /admin/virtualtopics/{virtualTopicId} \
  -H 'Authorization: Bearer {access-token}'

DELETE /virtualtopics/{virtualTopicId}

Delete a virtual topic.

The virtual topic must be unpublished with no remaining subscriptions. Note - You must be the owner to delete a virtual topic. You can view all of the virtual topics that you own (including their ID) by using GET /virtualtopics

Parameters

Name	In	Type	Required	Description
virtualTopicId	path	string	true	The ID of the virtual topic.

Responses

Status	Meaning	Description	Schema
200	OK	Virtual topic successfully deleted.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	This virtual topic does not exist.	None
409	Conflict	Virtual topic could not be deleted due to a conflict.	None
500	Internal Server Error	Internal error.	None

exportVirtualTopicAPICAsyncAPI

Code samples

# You can also use wget
curl -X GET /admin/virtualtopics/{virtualTopicId}/apicasyncapi \
  -H 'Accept: application/yaml' \
  -H 'Authorization: Bearer {access-token}'

GET /virtualtopics/{virtualTopicId}/apicasyncapi

Generate an AsyncAPI document for a selected virtual topic with connections added for IBM API Connect.

Parameters

Name	In	Type	Required	Description
virtualTopicId	path	string	true	The ID of the virtual topic.
version	query	string	false	The version of AsyncAPI

Example responses

200 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	AsyncAPI successfully generated.	string
400	Bad Request	Bad input.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	Virtual topic not found.	None
422	Unprocessable Entity	Cannot export virtual topic with approval control.	None
500	Internal Server Error	Internal error.	None

exportVirtualTopicAsyncAPI

Code samples

# You can also use wget
curl -X GET /admin/virtualtopics/{virtualTopicId}/asyncapi \
  -H 'Accept: application/yaml' \
  -H 'Authorization: Bearer {access-token}'

GET /virtualtopics/{virtualTopicId}/asyncapi

Generate an AsyncAPI document for a selected virtual topic.

Parameters

Name	In	Type	Required	Description
virtualTopicId	path	string	true	The ID of the virtual topic.
version	query	string	false	The version of AsyncAPI

Example responses

200 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	AsyncAPI successfully generated.	string
400	Bad Request	Bad input.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	Virtual topic not found.	None
500	Internal Server Error	Internal error.	None

deleteVirtualTopicApplicationSubscription

Code samples

# You can also use wget
curl -X DELETE /admin/virtualtopics/{virtualTopicId}/subscriptions/{applicationId} \
  -H 'Authorization: Bearer {access-token}'

DELETE /virtualtopics/{virtualTopicId}/subscriptions/{applicationId}

Delete an application subscription to this virtual topic. You must be the source topic owner or collaborator for the source topic to be able to delete the subscription.

Parameters

Name	In	Type	Required	Description
virtualTopicId	path	string	true	The ID of the virtual topic.
applicationId	path	string	true	The ID of the application.

Responses

Status	Meaning	Description	Schema
200	OK	Application subscriptions deleted successfully.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	This virtual topic or application does not exist.	None
500	Internal Server Error	Internal error.	None

addGroupVisibility

Code samples

# You can also use wget
curl -X POST /admin/groupvisibility \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /groupvisibility

Add virtual topics to the provided group visibility.

Body parameter

{
  "group": "string",
  "options": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	Group visibility data.
» group	body	string	true	Group to associate these virtual topics with.
» options	body	[string]	true	List of virtual topics visible to this group.

Example responses

200 Response

{
  "group": "string",
  "options": [
    {
      "id": "string",
      "alias": "string",
      "name": "string",
      "controls": [
        "approval"
      ],
      "eventSourceName": "string",
      "topicName": "string",
      "capabilities": [
        "consume"
      ],
      "hidden": true,
      "allowSubscriptions": true,
      "groupVisibility": [
        "string"
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Virtual topics that have group visibility.	Inline
400	Bad Request	Invalid request, request data does not match the schema or provided virtual topic ID does not exist.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» group	string	true	none	Group associated with these virtual topics.
» options	[object]	true	none	List of virtual topics visible to this group.
»» id	string	true	none	The ID for this virtual topic.
»» alias	string	true	none	The alias for this virtual topic.
»» name	string	true	none	The name for this virtual topic.
»» controls	[string]	true	none	none
»» eventSourceName	string	true	none	The source topic name for this virtual topic.
»» topicName	string	true	none	The Kafka topic for this virtual topic.
»» capabilities	[string]	true	none	none
»» hidden	boolean	false	none	Indicates if this virtual topic is visible in the catalog.
»» allowSubscriptions	boolean	false	none	Indicates if this virtual topic is allowing new subscriptions.
»» groupVisibility	[string]	false	none	List of groups this virtual topic should be visible to in the catalog.

readAllEventEndpoints

Code samples

# You can also use wget
curl -X GET /admin/eventendpoints \
  -H 'Accept: application/vnd.ibm.eem.v2+json' \
  -H 'Authorization: Bearer {access-token}'

GET /eventendpoints

List all event endpoints in an organization. To view all options with 11.7.1 or later controls in an event endpoint, you must specify the header 'Accept: application/vnd.ibm.eem.v2+json. If you omit the header or specify ‘application/json’, then the response includes only virtual topics that can be represented with 11.7.0 or earlier controls.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The page number of results to retrieve. If this number exceeds the available data, then the last page is returned.
maxPageSize	query	integer	false	The maximum number of entries to return per page. If not specified, all data items are returned.
filterBy	query	string	false	Capability to filter by.

Enumerated Values

Parameter	Value
filterBy	consume
filterBy	produce

Example responses

200 Response

application/vnd.ibm.eem.v2+json

[
  {
    "id": "string",
    "owner": "string",
    "organization": "string",
    "clusterId": "string",
    "type": "kafka",
    "encoding": "unknown",
    "name": "string",
    "contact": "string",
    "description": "string",
    "topic": {
      "name": "string",
      "partitions": 0,
      "replicas": 0,
      "uuid": "string"
    },
    "schema": {
      "type": "avro",
      "content": "string",
      "description": "string"
    },
    "tags": [
      "string"
    ],
    "sampleMessages": [
      "string"
    ],
    "capabilities": [
      "consume"
    ],
    "options": [
      {
        "id": "string",
        "owner": "string",
        "organization": "string",
        "eventSourceId": "string",
        "alias": "string",
        "name": "string",
        "description": "string",
        "gatewayGroups": [
          "string"
        ],
        "hidden": true,
        "allowSubscriptions": true,
        "controls": [
          {
            "id": "string",
            "type": "approval",
            "requests": [
              {
                "id": "string",
                "owner": "string",
                "lastUpdated": 0,
                "status": "pending",
                "description": "string",
                "contact": "string",
                "outcome": "string",
                "subscriptionId": "string",
                "applicationId": "string"
              }
            ]
          }
        ],
        "gatewaysPublishedTo": [
          {
            "id": "string",
            "owner": "string",
            "organization": "string",
            "gatewayId": "string",
            "group": "string",
            "organizations": [
              "string"
            ],
            "servedOrganizations": [
              "string"
            ],
            "contact": "string",
            "lastContact": 0,
            "endpoints": [
              {
                "host": "string",
                "port": 0,
                "ssl": false,
                "certificates": [
                  {
                    "pem": "string",
                    "subject": "string",
                    "sans": [
                      "string"
                    ],
                    "issuer": "string",
                    "expiry": 0
                  }
                ]
              }
            ],
            "version": "string",
            "productVersion": "string",
            "features": [
              "string"
            ],
            "deploymentMode": "string",
            "capabilities": {}
          }
        ]
      }
    ],
    "collaborators": {
      "groups": [
        "string"
      ],
      "contacts": [
        "string"
      ]
    }
  }
]

application/json

[
  {
    "id": "string",
    "owner": "string",
    "organization": "string",
    "clusterId": "string",
    "type": "kafka",
    "encoding": "unknown",
    "name": "string",
    "contact": "string",
    "description": "string",
    "topic": {
      "name": "string",
      "partitions": 0,
      "replicas": 0,
      "uuid": "string"
    },
    "schema": {
      "type": "avro",
      "content": "string",
      "description": "string"
    },
    "tags": [
      "string"
    ],
    "sampleMessages": [
      "string"
    ],
    "capabilities": [
      "consume"
    ],
    "options": [
      {
        "id": "string",
        "owner": "string",
        "organization": "string",
        "eventSourceId": "string",
        "alias": "string",
        "name": "string",
        "description": "string",
        "gatewayGroups": [
          "string"
        ],
        "hidden": true,
        "allowSubscriptions": true,
        "controls": [
          {
            "id": "string",
            "type": "approval",
            "requests": [
              {
                "id": "string",
                "owner": "string",
                "lastUpdated": 0,
                "status": "pending",
                "description": "string",
                "contact": "string",
                "outcome": "string",
                "subscriptionId": "string",
                "applicationId": "string"
              }
            ]
          }
        ],
        "gatewaysPublishedTo": [
          {
            "id": "string",
            "owner": "string",
            "organization": "string",
            "gatewayId": "string",
            "group": "string",
            "organizations": [
              "string"
            ],
            "servedOrganizations": [
              "string"
            ],
            "contact": "string",
            "lastContact": 0,
            "endpoints": [
              {
                "host": "string",
                "port": 0,
                "ssl": false,
                "certificates": [
                  {
                    "pem": "string",
                    "subject": "string",
                    "sans": [
                      "string"
                    ],
                    "issuer": "string",
                    "expiry": 0
                  }
                ]
              }
            ],
            "version": "string",
            "productVersion": "string",
            "features": [
              "string"
            ],
            "deploymentMode": "string",
            "capabilities": {}
          }
        ]
      }
    ],
    "collaborators": {
      "groups": [
        "string"
      ],
      "contacts": [
        "string"
      ]
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Event endpoints successfully listed.	Inline
304	Not Modified	Data not changed.	None
400	Bad Request	Invalid request, only one of page and maxPageSize were supplied or max page size exceeded.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
406	Not Acceptable	Not Acceptable. The requested media type is not supported.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

application/vnd.ibm.eem.v2+json (V2 API)

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique ID of related source topic.
» owner	string	true	none	Owner of the related source topic.
» organization	string	true	none	Organization the related source topic belongs to.
» clusterId	string	true	none	ID for the cluster that contains the connection details for this source topic.
» type	string	true	none	Type of source topic.
» encoding	string	true	none	The encoding of the data on this source topic.
» name	string	true	none	Source topic name.
» contact	string	true	none	Who to contact for more information about this source topic.
» description	string	false	none	A description for this source topic.
» topic	object	false	none	none
»» name	string	true	none	Actual topic name in the cluster.
»» partitions	number	false	none	The number of partitions for this topic.
»» replicas	number	false	none	The number of replicas for this topic.
»» uuid	string	false	none	The UUID of the topic.
» schema	object	false	none	none
»» type	string	false	none	Type of schema from the list of valid types.
»» content	string	false	none	Contents of the schema.
»» description	string	false	none	Description of the data available on the source topic.
» tags	[string]	false	none	List of tags associated with this source topic.
» sampleMessages	[string]	false	none	none
» capabilities	[string]	true	none	none
» options	[object]	true	none	none
»» id	string	true	none	Unique virtual topic ID.
»» owner	string	true	none	Virtual topic owner.
»» organization	string	true	none	Organization this virtual topic belongs to.
»» eventSourceId	string	true	none	Source topic that this virtual topic belongs to.
»» alias	string	true	none	Unique, descriptive alias for this virtual topic.
»» name	string	true	none	Descriptive name for this virtual topic.
»» description	string	false	none	Longer description used to describe what this virtual topic is used for.
»» gatewayGroups	[string]	true	none	List of gateway groups this virtual topic should be published to.
»» hidden	boolean	true	none	Indicates if this virtual topic is visible in the catalog.
»» allowSubscriptions	boolean	true	none	Indicates if this virtual topic is allowing new subscriptions.
»» controls	[anyOf]	true	none	Controls on this virtual topic.

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» requests	[object]	true	none	none
»»»»» id	string	true	none	Unique approval request ID.
»»»»» owner	string	true	none	Approval request owner.
»»»»» lastUpdated	integer	false	none	Unix Epoch timestamp of last update to approval request.
»»»»» status	string	true	none	The status of this approval request.
»»»»» description	string	true	none	Description of why the request was created.
»»»»» contact	string	true	none	Contact details of the person making the request.
»»»»» outcome	string	false	none	Description of the outcome of this request.
»»»»» subscriptionId	string	false	none	The id of the subscription associated with this request.
»»»»» applicationId	string	false	none	The id of the application associated with this request.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» redactions	[anyOf]	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» type	string	true	none	Type of redaction.
»»»»»»» replaceWith	string	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» type	any	true	none	Type of redaction.
»»»»»»» replaceWith	number	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» type	string	true	none	Type of redaction.
»»»»»»» algorithm	string	true	none	Algorithm to use for hashing the current value.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» schema	object	true	none	none
»»»»» filtered	boolean	true	none	If true, any schema associated with the source topic will be used to filter records sent to applications.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»»» messagesPerSecond	number	false	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» megabytesPerSecond	number	false	none	Upper limit to megabytes per second produced/consumed.
»»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» trustPem	string	true	none	Certificate Authority in PEM format.

xor

Name	Type	Required	Restrictions	Description
»»»»» anonymous	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.
»»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

and

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» id	string	true	none	Unique control ID.
»»»»» type	string	true	none	none
»»»»» identificationType	string	false	none	The type of identification users will use to distinguish between subscriptions. Defaults to MTLS when not provided.
»»»»» identificationSubjectFields	[string]	false	none	Certificate subject fields to identify users by if using MTLS identificationType.
»»»»» subjectCommonName	string	true	none	Subject Common Name to match on.
»»»»» subjectOrganization	string	false	none	Subject Organization to match on.
»»»»» subjectCountry	string	false	none	Subject Country to match on.
»»»»» subjectStateOrProvince	string	false	none	Subject Region to match on.
»»»»» subjectLocality	string	false	none	Subject Locality to match on.
»»»»» approvedCipherSuites	[string]	false	none	Cipher suites that are approved for use.
»»»»» disapprovedCipherSuites	[string]	false	none	Cipher suites that are not approved for use.
»»»»» notValidBefore	integer	false	none	Certificate not valid before time.
»»»»» notValidAfter	integer	false	none	Certificate not valid after time.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» filterCondition	object	true	none	none
»»»»» type	string	true	none	none
»»»»» eventProperty	object	true	none	none
»»»»»» path	string	true	none	JSONPath to the field.
»»»»»» source	string	true	none	Location of the property in the event.
»»»»» operator	object	true	none	none
»»»»»» name	string	true	none	none
»»»»»» type	string	true	none	none
»»»»» value	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» type	string	true	none	none
»»»»»»» value	any	true	none	Literal comparison value.

oneOf

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	string	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	number	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	boolean	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» type	string	true	none	none
»»»»»»» value	string	true	none	Reference to a Kafka connection metadata property.

continued

Name	Type	Required	Restrictions	Description
»» gatewaysPublishedTo	[object]	true	none	List of gateways that this virtual topic has been published to.
»»» id	string	true	none	Unique event gateway ID.
»»» owner	string	true	none	Owner of the event gateway.
»»» organization	string	true	none	Organization this event gateway belongs to.
»»» gatewayId	string	true	none	Unique event gateway ID within this group.
»»» group	string	true	none	Event gateway group name.
»»» organizations	[string]	true	none	Organizations this event gateway serves.
»»» servedOrganizations	[string]	true	none	Organizations this event gateway serves.
»»» contact	string	false	none	The contact information for this event gateway.
»»» lastContact	integer	true	none	Epoch time in ms of the last contact from this gateway.
»»» endpoints	[object]	true	none	Endpoints that the gateway is listening on.
»»»» host	string	true	none	Kafka server host name.
»»»» port	integer	true	none	Kafka server port.
»»»» ssl	boolean	false	none	Connect over SSL.
»»»» certificates	[object]	false	none	Certificates or CAs to trust, required to connect to the server via SSL.
»»»»» pem	string	true	none	Certificate in PEM format
»»»»» subject	string	false	none	Subject name of the certificate
»»»»» sans	[string]	false	none	A list of subject alternative names of the certificate
»»»»» issuer	string	false	none	Issuer of the certificate
»»»»» expiry	integer	false	none	Expiration date of the certificate in epoch millis
»»» version	string	false	none	Version of the gateway.
»»» productVersion	string	false	none	EEM product version.
»»» features	[string]	false	none	Feature set in use by gateway.
»»» deploymentMode	string	false	none	Type of gateway deployment.
»»» capabilities	object	false	none	Description of what capabilities the gateway has.
» collaborators	object	true	none	Collaborators for this endpoint.
»» groups	[string]	true	none	List of groups that collaborate on this event endpoint.
»» contacts	[string]	true	none	List of contacts that collaborate on this event endpoint.

Enumerated Values

Property	Value
type	kafka
encoding	unknown
encoding	text/plain
encoding	application/octet-stream
encoding	application/json
encoding	avro/binary
encoding	avro/json
type	avro
type	json
type	unknown
type	approval
status	pending
status	approved
status	rejected
status	fulfilled
type	redaction
type	replaceString
type	replaceIntegral
type	replaceDouble
type	hash
algorithm	SHA-256
algorithm	SHA-512
type	schema-filtering
type	quota
type	mtls
identificationType	MTLS
identificationType	SASL
type	sasl-oauth
type	sasl-credentials
type	content-filtering
type	simple
source	body
name	equal
type	string
type	integer
type	double
type	boolean
type	literal
type	reference
value	USER_ID
value	CLIENT_ID

application/json (V1 API)

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique ID of the related source topic.
» owner	string	true	none	Owner of the related source topic.
» organization	string	true	none	Organization the related source topic belongs to.
» clusterId	string	true	none	ID for the cluster that contains the connection details for this source topic.
» type	string	true	none	Type of source topic.
» encoding	string	true	none	The encoding of the data on this source topic.
» name	string	true	none	Source topic name.
» contact	string	true	none	Who to contact for more information about this source topic.
» description	string	false	none	A description for this source topic.
» topic	object	false	none	none
»» name	string	true	none	Actual topic name in the cluster.
»» partitions	number	false	none	The number of partitions for this topic.
»» replicas	number	false	none	The number of replicas for this topic.
»» uuid	string	false	none	The UUID of the topic.
» schema	object	false	none	none
»» type	string	false	none	Type of schema from the list of valid types.
»» content	string	false	none	Contents of the schema.
»» description	string	false	none	Description of the data available on the source topic.
» tags	[string]	false	none	List of tags associated with this source topic.
» sampleMessages	[string]	false	none	none
» capabilities	[string]	true	none	none
» options	[object]	true	none	none
»» id	string	true	none	Unique virtual topic ID.
»» owner	string	true	none	Virtual topic owner.
»» organization	string	true	none	Organization this virtual topic belongs to.
»» eventSourceId	string	true	none	Source topic that this virtual topic belongs to.
»» alias	string	true	none	Unique, descriptive alias for this virtual topic.
»» name	string	true	none	Descriptive name for this virtual topic.
»» description	string	false	none	Longer description used to describe what this virtual topic is used for.
»» gatewayGroups	[string]	true	none	List of gateway groups this virtual topic should be published to.
»» hidden	boolean	true	none	Indicates if this virtual topic is visible in the catalog.
»» allowSubscriptions	boolean	true	none	Indicates if this virtual topic is allowing new subscriptions.
»» controls	[anyOf]	true	none	Controls on this virtual topic.

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» requests	[object]	true	none	none
»»»»» id	string	true	none	Unique approval request ID.
»»»»» owner	string	true	none	Approval request owner.
»»»»» lastUpdated	integer	false	none	Unix Epoch timestamp of last update to approval request.
»»»»» status	string	true	none	The status of this approval request.
»»»»» description	string	true	none	Description of why the request was created.
»»»»» contact	string	true	none	Contact details of the person making the request.
»»»»» outcome	string	false	none	Description of the outcome of this request.
»»»»» subscriptionId	string	false	none	The id of the subscription associated with this request.
»»»»» applicationId	string	false	none	The id of the application associated with this request.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» redactions	[anyOf]	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» type	string	true	none	Type of redaction.
»»»»»»» replaceWith	string	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» type	any	true	none	Type of redaction.
»»»»»»» replaceWith	number	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» type	string	true	none	Type of redaction.
»»»»»»» algorithm	string	true	none	Algorithm to use for hashing the current value.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» schema	object	true	none	none
»»»»» filtered	boolean	true	none	If true, any schema associated with the source topic will be used to filter records sent to applications.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»»» messagesPerSecond	number	false	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» megabytesPerSecond	number	false	none	Upper limit to megabytes per second produced/consumed.
»»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» trustPem	string	true	none	Certificate Authority in PEM format.

xor

Name	Type	Required	Restrictions	Description
»»»»» anonymous	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.
»»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

and

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» id	string	true	none	Unique control ID.
»»»»» type	string	true	none	none
»»»»» identificationType	string	false	none	The type of identification users will use to distinguish between subscriptions. Defaults to MTLS when not provided.
»»»»» identificationSubjectFields	[string]	false	none	Certificate subject fields to identify users by if using MTLS identificationType.
»»»»» subjectCommonName	string	true	none	Subject Common Name to match on.
»»»»» subjectOrganization	string	false	none	Subject Organization to match on.
»»»»» subjectCountry	string	false	none	Subject Country to match on.
»»»»» subjectStateOrProvince	string	false	none	Subject Region to match on.
»»»»» subjectLocality	string	false	none	Subject Locality to match on.
»»»»» approvedCipherSuites	[string]	false	none	Cipher suites that are approved for use.
»»»»» disapprovedCipherSuites	[string]	false	none	Cipher suites that are not approved for use.
»»»»» notValidBefore	integer	false	none	Certificate not valid before time.
»»»»» notValidAfter	integer	false	none	Certificate not valid after time.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» filterCondition	object	true	none	none
»»»»» type	string	true	none	none
»»»»» eventProperty	object	true	none	none
»»»»»» path	string	true	none	JSONPath to the field.
»»»»»» source	string	true	none	Location of the property in the event.
»»»»» operator	object	true	none	none
»»»»»» name	string	true	none	none
»»»»»» type	string	true	none	none
»»»»» value	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» type	string	true	none	none
»»»»»»» value	any	true	none	Literal comparison value.

oneOf

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	string	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	number	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	boolean	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» type	string	true	none	none
»»»»»»» value	string	true	none	Reference to a Kafka connection metadata property.

continued

Name	Type	Required	Restrictions	Description
»» gatewaysPublishedTo	[object]	true	none	List of gateways that this virtual topic has been published to.
»»» id	string	true	none	Unique event gateway ID.
»»» owner	string	true	none	Owner of the event gateway.
»»» organization	string	true	none	Organization this event gateway belongs to.
»»» gatewayId	string	true	none	Unique event gateway ID within this group.
»»» group	string	true	none	Event gateway group name.
»»» organizations	[string]	true	none	Organizations this event gateway serves.
»»» servedOrganizations	[string]	true	none	Organizations this event gateway serves.
»»» contact	string	false	none	The contact information for this event gateway.
»»» lastContact	integer	true	none	Epoch time in ms of the last contact from this gateway.
»»» endpoints	[object]	true	none	Endpoints that the gateway is listening on.
»»»» host	string	true	none	Kafka server host name.
»»»» port	integer	true	none	Kafka server port.
»»»» ssl	boolean	false	none	Connect over SSL.
»»»» certificates	[object]	false	none	Certificates or CAs to trust, required to connect to the server via SSL.
»»»»» pem	string	true	none	Certificate in PEM format
»»»»» subject	string	false	none	Subject name of the certificate
»»»»» sans	[string]	false	none	A list of subject alternative names of the certificate
»»»»» issuer	string	false	none	Issuer of the certificate
»»»»» expiry	integer	false	none	Expiration date of the certificate in epoch millis
»»» version	string	false	none	Version of the gateway.
»»» productVersion	string	false	none	EEM product version.
»»» features	[string]	false	none	Feature set in use by gateway.
»»» deploymentMode	string	false	none	Type of gateway deployment.
»»» capabilities	object	false	none	Description of what capabilities the gateway has.
» collaborators	object	true	none	Collaborators for this endpoint.
»» groups	[string]	true	none	List of groups that collaborate on this event endpoint.
»» contacts	[string]	true	none	List of contacts that collaborate on this event endpoint.

Enumerated Values

Property	Value
type	kafka
encoding	unknown
encoding	text/plain
encoding	application/octet-stream
encoding	application/json
encoding	avro/binary
encoding	avro/json
type	avro
type	json
type	unknown
type	approval
status	pending
status	approved
status	rejected
status	fulfilled
type	redaction
type	replaceString
type	replaceIntegral
type	replaceDouble
type	hash
algorithm	SHA-256
algorithm	SHA-512
type	schema-filtering
type	quota
type	mtls
identificationType	MTLS
identificationType	SASL
type	content-filtering
type	simple
source	body
name	equal
type	string
type	integer
type	double
type	boolean
type	literal
type	reference
value	USER_ID
value	CLIENT_ID

Response Headers

Status	Header	Type	Format	Description
200	ei-pagination-total	integer		Total number of items available for retrieval (including current page).
200	etag	string		An identifier that can be supplied with the If-None-Match header to indicate that unchanged results should return 304 with no data.

readEventEndpoint

Code samples

# You can also use wget
curl -X GET /admin/eventendpoints/{eventSourceId} \
  -H 'Accept: application/vnd.ibm.eem.v2+json' \
  -H 'Authorization: Bearer {access-token}'

GET /eventendpoints/{eventSourceId}

Read an event endpoint. To view all virtual topics with 11.7.1 or later controls in an event endpoint, you must specify the header ‘Accept: application/vnd.ibm.eem.v2+json’. If you omit the header or specify ‘application/json’, then the response includes only virtual topics that can be represented with 11.7.0 or earlier controls.

Parameters

Name	In	Type	Required	Description
eventSourceId	path	string	true	The ID of the source topic to read an event endpoint from.

Example responses

200 Response

application/vnd.ibm.eem.v2+json

{
  "id": "string",
  "owner": "string",
  "organization": "string",
  "clusterId": "string",
  "type": "kafka",
  "encoding": "unknown",
  "name": "string",
  "contact": "string",
  "description": "string",
  "topic": {
    "name": "string",
    "partitions": 0,
    "replicas": 0,
    "uuid": "string"
  },
  "schema": {
    "type": "avro",
    "content": "string",
    "description": "string"
  },
  "tags": [
    "string"
  ],
  "sampleMessages": [
    "string"
  ],
  "capabilities": [
    "consume"
  ],
  "options": [
    {
      "id": "string",
      "owner": "string",
      "organization": "string",
      "eventSourceId": "string",
      "alias": "string",
      "name": "string",
      "description": "string",
      "gatewayGroups": [
        "string"
      ],
      "hidden": true,
      "allowSubscriptions": true,
      "controls": [
        {
          "id": "string",
          "type": "approval",
          "requests": [
            {
              "id": "string",
              "owner": "string",
              "lastUpdated": 0,
              "status": "pending",
              "description": "string",
              "contact": "string",
              "outcome": "string",
              "subscriptionId": "string",
              "applicationId": "string"
            }
          ]
        }
      ],
      "gatewaysPublishedTo": [
        {
          "id": "string",
          "owner": "string",
          "organization": "string",
          "gatewayId": "string",
          "group": "string",
          "organizations": [
            "string"
          ],
          "servedOrganizations": [
            "string"
          ],
          "contact": "string",
          "lastContact": 0,
          "endpoints": [
            {
              "host": "string",
              "port": 0,
              "ssl": false,
              "certificates": [
                {
                  "pem": "string",
                  "subject": "string",
                  "sans": [
                    "string"
                  ],
                  "issuer": "string",
                  "expiry": 0
                }
              ]
            }
          ],
          "version": "string",
          "productVersion": "string",
          "features": [
            "string"
          ],
          "deploymentMode": "string",
          "capabilities": {}
        }
      ]
    }
  ],
  "collaborators": {
    "groups": [
      "string"
    ],
    "contacts": [
      "string"
    ]
  }
}

application/json

{
  "id": "string",
  "owner": "string",
  "organization": "string",
  "clusterId": "string",
  "type": "kafka",
  "encoding": "unknown",
  "name": "string",
  "contact": "string",
  "description": "string",
  "topic": {
    "name": "string",
    "partitions": 0,
    "replicas": 0,
    "uuid": "string"
  },
  "schema": {
    "type": "avro",
    "content": "string",
    "description": "string"
  },
  "tags": [
    "string"
  ],
  "sampleMessages": [
    "string"
  ],
  "capabilities": [
    "consume"
  ],
  "options": [
    {
      "id": "string",
      "owner": "string",
      "organization": "string",
      "eventSourceId": "string",
      "alias": "string",
      "name": "string",
      "description": "string",
      "gatewayGroups": [
        "string"
      ],
      "hidden": true,
      "allowSubscriptions": true,
      "controls": [
        {
          "id": "string",
          "type": "approval",
          "requests": [
            {
              "id": "string",
              "owner": "string",
              "lastUpdated": 0,
              "status": "pending",
              "description": "string",
              "contact": "string",
              "outcome": "string",
              "subscriptionId": "string",
              "applicationId": "string"
            }
          ]
        }
      ],
      "gatewaysPublishedTo": [
        {
          "id": "string",
          "owner": "string",
          "organization": "string",
          "gatewayId": "string",
          "group": "string",
          "organizations": [
            "string"
          ],
          "servedOrganizations": [
            "string"
          ],
          "contact": "string",
          "lastContact": 0,
          "endpoints": [
            {
              "host": "string",
              "port": 0,
              "ssl": false,
              "certificates": [
                {
                  "pem": "string",
                  "subject": "string",
                  "sans": [
                    "string"
                  ],
                  "issuer": "string",
                  "expiry": 0
                }
              ]
            }
          ],
          "version": "string",
          "productVersion": "string",
          "features": [
            "string"
          ],
          "deploymentMode": "string",
          "capabilities": {}
        }
      ]
    }
  ],
  "collaborators": {
    "groups": [
      "string"
    ],
    "contacts": [
      "string"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Event endpoint successfully retrieved.	Inline
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	This event endpoint does not exist.	None
406	Not Acceptable	Not Acceptable. The requested media type is not supported.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

application/vnd.ibm.eem.v2+json (V2 API)

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique ID of related source topic.
» owner	string	true	none	Owner of the related source topic.
» organization	string	true	none	Organization the related source topic belongs to.
» clusterId	string	true	none	ID for the cluster that contains the connection details for this source topic.
» type	string	true	none	Type of source topic.
» encoding	string	true	none	The encoding of the data on this source topic.
» name	string	true	none	Source topic name.
» contact	string	true	none	Who to contact for more information about this source topic.
» description	string	false	none	A description for this source topic.
» topic	object	false	none	none
»» name	string	true	none	Actual topic name in the cluster.
»» partitions	number	false	none	The number of partitions for this topic.
»» replicas	number	false	none	The number of replicas for this topic.
»» uuid	string	false	none	The UUID of the topic.
» schema	object	false	none	none
»» type	string	false	none	Type of schema from the list of valid types.
»» content	string	false	none	Contents of the schema.
»» description	string	false	none	Description of the data available on the source topic.
» tags	[string]	false	none	List of tags associated with this source topic.
» sampleMessages	[string]	false	none	none
» capabilities	[string]	true	none	none
» options	[object]	true	none	none
»» id	string	true	none	Unique virtual topic ID.
»» owner	string	true	none	Virtual topic owner.
»» organization	string	true	none	Organization this virtual topic belongs to.
»» eventSourceId	string	true	none	Source topic that this virtual topic belongs to.
»» alias	string	true	none	Unique, descriptive alias for this virtual topic.
»» name	string	true	none	Descriptive name for this virtual topic.
»» description	string	false	none	Longer description used to describe what this virtual topic is used for.
»» gatewayGroups	[string]	true	none	List of gateway groups this virtual topic should be published to.
»» hidden	boolean	true	none	Indicates if this virtual topic is visible in the catalog.
»» allowSubscriptions	boolean	true	none	Indicates if this virtual topic is allowing new subscriptions.
»» controls	[anyOf]	true	none	Controls on this virtual topic.

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» requests	[object]	true	none	none
»»»»» id	string	true	none	Unique approval request ID.
»»»»» owner	string	true	none	Approval request owner.
»»»»» lastUpdated	integer	false	none	Unix Epoch timestamp of last update to approval request.
»»»»» status	string	true	none	The status of this approval request.
»»»»» description	string	true	none	Description of why the request was created.
»»»»» contact	string	true	none	Contact details of the person making the request.
»»»»» outcome	string	false	none	Description of the outcome of this request.
»»»»» subscriptionId	string	false	none	The id of the subscription associated with this request.
»»»»» applicationId	string	false	none	The id of the application associated with this request.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» redactions	[anyOf]	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» type	string	true	none	Type of redaction.
»»»»»»» replaceWith	string	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» type	any	true	none	Type of redaction.
»»»»»»» replaceWith	number	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» type	string	true	none	Type of redaction.
»»»»»»» algorithm	string	true	none	Algorithm to use for hashing the current value.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» schema	object	true	none	none
»»»»» filtered	boolean	true	none	If true, any schema associated with the source topic will be used to filter records sent to applications.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»»» messagesPerSecond	number	false	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» megabytesPerSecond	number	false	none	Upper limit to megabytes per second produced/consumed.
»»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» trustPem	string	true	none	Certificate Authority in PEM format.

xor

Name	Type	Required	Restrictions	Description
»»»»» anonymous	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.
»»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

and

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» id	string	true	none	Unique control ID.
»»»»» type	string	true	none	none
»»»»» identificationType	string	false	none	The type of identification users will use to distinguish between subscriptions. Defaults to MTLS when not provided.
»»»»» identificationSubjectFields	[string]	false	none	Certificate subject fields to identify users by if using MTLS identificationType.
»»»»» subjectCommonName	string	true	none	Subject Common Name to match on.
»»»»» subjectOrganization	string	false	none	Subject Organization to match on.
»»»»» subjectCountry	string	false	none	Subject Country to match on.
»»»»» subjectStateOrProvince	string	false	none	Subject Region to match on.
»»»»» subjectLocality	string	false	none	Subject Locality to match on.
»»»»» approvedCipherSuites	[string]	false	none	Cipher suites that are approved for use.
»»»»» disapprovedCipherSuites	[string]	false	none	Cipher suites that are not approved for use.
»»»»» notValidBefore	integer	false	none	Certificate not valid before time.
»»»»» notValidAfter	integer	false	none	Certificate not valid after time.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» filterCondition	object	true	none	none
»»»»» type	string	true	none	none
»»»»» eventProperty	object	true	none	none
»»»»»» path	string	true	none	JSONPath to the field.
»»»»»» source	string	true	none	Location of the property in the event.
»»»»» operator	object	true	none	none
»»»»»» name	string	true	none	none
»»»»»» type	string	true	none	none
»»»»» value	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» type	string	true	none	none
»»»»»»» value	any	true	none	Literal comparison value.

oneOf

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	string	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	number	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	boolean	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» type	string	true	none	none
»»»»»»» value	string	true	none	Reference to a Kafka connection metadata property.

continued

Name	Type	Required	Restrictions	Description
»» gatewaysPublishedTo	[object]	true	none	List of gateways that this virtual topic has been published to.
»»» id	string	true	none	Unique event gateway ID.
»»» owner	string	true	none	Owner of the event gateway.
»»» organization	string	true	none	Organization this event gateway belongs to.
»»» gatewayId	string	true	none	Unique event gateway ID within this group.
»»» group	string	true	none	Event gateway group name.
»»» organizations	[string]	true	none	Organizations this event gateway serves.
»»» servedOrganizations	[string]	true	none	Organizations this event gateway serves.
»»» contact	string	false	none	The contact information for this event gateway.
»»» lastContact	integer	true	none	Epoch time in ms of the last contact from this gateway.
»»» endpoints	[object]	true	none	Endpoints that the gateway is listening on.
»»»» host	string	true	none	Kafka server host name.
»»»» port	integer	true	none	Kafka server port.
»»»» ssl	boolean	false	none	Connect over SSL.
»»»» certificates	[object]	false	none	Certificates or CAs to trust, required to connect to the server via SSL.
»»»»» pem	string	true	none	Certificate in PEM format
»»»»» subject	string	false	none	Subject name of the certificate
»»»»» sans	[string]	false	none	A list of subject alternative names of the certificate
»»»»» issuer	string	false	none	Issuer of the certificate
»»»»» expiry	integer	false	none	Expiration date of the certificate in epoch millis
»»» version	string	false	none	Version of the gateway.
»»» productVersion	string	false	none	EEM product version.
»»» features	[string]	false	none	Feature set in use by gateway.
»»» deploymentMode	string	false	none	Type of gateway deployment.
»»» capabilities	object	false	none	Description of what capabilities the gateway has.
» collaborators	object	true	none	Collaborators for this endpoint.
»» groups	[string]	true	none	List of groups that collaborate on this event endpoint.
»» contacts	[string]	true	none	List of contacts that collaborate on this event endpoint.

Enumerated Values

Property	Value
type	kafka
encoding	unknown
encoding	text/plain
encoding	application/octet-stream
encoding	application/json
encoding	avro/binary
encoding	avro/json
type	avro
type	json
type	unknown
type	approval
status	pending
status	approved
status	rejected
status	fulfilled
type	redaction
type	replaceString
type	replaceIntegral
type	replaceDouble
type	hash
algorithm	SHA-256
algorithm	SHA-512
type	schema-filtering
type	quota
type	mtls
identificationType	MTLS
identificationType	SASL
type	sasl-oauth
type	sasl-credentials
type	content-filtering
type	simple
source	body
name	equal
type	string
type	integer
type	double
type	boolean
type	literal
type	reference
value	USER_ID
value	CLIENT_ID

application/json (V1 API)

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique ID of the related source topic.
» owner	string	true	none	Owner of the related source topic.
» organization	string	true	none	Organization the related source topic belongs to.
» clusterId	string	true	none	ID for the cluster that contains the connection details for this source topic.
» type	string	true	none	Type of source topic.
» encoding	string	true	none	The encoding of the data on this source topic.
» name	string	true	none	Source topic name.
» contact	string	true	none	Who to contact for more information about this source topic.
» description	string	false	none	A description for this source topic.
» topic	object	false	none	none
»» name	string	true	none	Actual topic name in the cluster.
»» partitions	number	false	none	The number of partitions for this topic.
»» replicas	number	false	none	The number of replicas for this topic.
»» uuid	string	false	none	The UUID of the topic.
» schema	object	false	none	none
»» type	string	false	none	Type of schema from the list of valid types.
»» content	string	false	none	Contents of the schema.
»» description	string	false	none	Description of the data available on the source topic.
» tags	[string]	false	none	List of tags associated with this source topic.
» sampleMessages	[string]	false	none	none
» capabilities	[string]	true	none	none
» options	[object]	true	none	none
»» id	string	true	none	Unique virtual topic ID.
»» owner	string	true	none	Virtual topic owner.
»» organization	string	true	none	Organization this virtual topic belongs to.
»» eventSourceId	string	true	none	Source topic that this virtual topic belongs to.
»» alias	string	true	none	Unique, descriptive alias for this virtual topic.
»» name	string	true	none	Descriptive name for this virtual topic.
»» description	string	false	none	Longer description used to describe what this virtual topic is used for.
»» gatewayGroups	[string]	true	none	List of gateway groups this virtual topic should be published to.
»» hidden	boolean	true	none	Indicates if this virtual topic is visible in the catalog.
»» allowSubscriptions	boolean	true	none	Indicates if this virtual topic is allowing new subscriptions.
»» controls	[anyOf]	true	none	Controls on this virtual topic.

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» requests	[object]	true	none	none
»»»»» id	string	true	none	Unique approval request ID.
»»»»» owner	string	true	none	Approval request owner.
»»»»» lastUpdated	integer	false	none	Unix Epoch timestamp of last update to approval request.
»»»»» status	string	true	none	The status of this approval request.
»»»»» description	string	true	none	Description of why the request was created.
»»»»» contact	string	true	none	Contact details of the person making the request.
»»»»» outcome	string	false	none	Description of the outcome of this request.
»»»»» subscriptionId	string	false	none	The id of the subscription associated with this request.
»»»»» applicationId	string	false	none	The id of the application associated with this request.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» redactions	[anyOf]	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» type	string	true	none	Type of redaction.
»»»»»»» replaceWith	string	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» type	any	true	none	Type of redaction.
»»»»»»» replaceWith	number	true	none	The value to replace with.

or

Name	Type	Required	Restrictions	Description
»»»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» path	string	true	none	The JSON path specifying the field to redact. JSON path is currently restricted to just field names (no arrays or functions).

and

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» type	string	true	none	Type of redaction.
»»»»»»» algorithm	string	true	none	Algorithm to use for hashing the current value.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» schema	object	true	none	none
»»»»» filtered	boolean	true	none	If true, any schema associated with the source topic will be used to filter records sent to applications.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»»» messagesPerSecond	number	false	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» megabytesPerSecond	number	false	none	Upper limit to megabytes per second produced/consumed.
»»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» megabytesPerSecond	number	true	none	Upper limit to megabytes per second produced/consumed.
»»»»» messagesPerSecond	number	true	none	Upper limit to messages per second produced/consumed.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»» anonymous	object	false	none	none
»»»»»» trustPem	string	true	none	Certificate Authority in PEM format.

xor

Name	Type	Required	Restrictions	Description
»»»»» anonymous	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

or

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» acceptProfileCa	boolean	true	none	Boolean indicating whether to include the Author defined CA certificates in the MTLS truststore.
»»»»»»» acceptOrgCa	boolean	true	none	Boolean indicating whether to include the Admin defined CA certificates in the MTLS truststore.

and

Name	Type	Required	Restrictions	Description
»»»» anonymous	object	false	none	none
»»»»» id	string	true	none	Unique control ID.
»»»»» type	string	true	none	none
»»»»» identificationType	string	false	none	The type of identification users will use to distinguish between subscriptions. Defaults to MTLS when not provided.
»»»»» identificationSubjectFields	[string]	false	none	Certificate subject fields to identify users by if using MTLS identificationType.
»»»»» subjectCommonName	string	true	none	Subject Common Name to match on.
»»»»» subjectOrganization	string	false	none	Subject Organization to match on.
»»»»» subjectCountry	string	false	none	Subject Country to match on.
»»»»» subjectStateOrProvince	string	false	none	Subject Region to match on.
»»»»» subjectLocality	string	false	none	Subject Locality to match on.
»»»»» approvedCipherSuites	[string]	false	none	Cipher suites that are approved for use.
»»»»» disapprovedCipherSuites	[string]	false	none	Cipher suites that are not approved for use.
»»»»» notValidBefore	integer	false	none	Certificate not valid before time.
»»»»» notValidAfter	integer	false	none	Certificate not valid after time.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» id	string	true	none	Unique control ID.
»»»» type	string	true	none	none
»»»» filterCondition	object	true	none	none
»»»»» type	string	true	none	none
»»»»» eventProperty	object	true	none	none
»»»»»» path	string	true	none	JSONPath to the field.
»»»»»» source	string	true	none	Location of the property in the event.
»»»»» operator	object	true	none	none
»»»»»» name	string	true	none	none
»»»»»» type	string	true	none	none
»»»»» value	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» type	string	true	none	none
»»»»»»» value	any	true	none	Literal comparison value.

oneOf

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	string	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	number	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»»»» anonymous	boolean	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none
»»»»»»» type	string	true	none	none
»»»»»»» value	string	true	none	Reference to a Kafka connection metadata property.

continued

Name	Type	Required	Restrictions	Description
»» gatewaysPublishedTo	[object]	true	none	List of gateways that this virtual topic has been published to.
»»» id	string	true	none	Unique event gateway ID.
»»» owner	string	true	none	Owner of the event gateway.
»»» organization	string	true	none	Organization this event gateway belongs to.
»»» gatewayId	string	true	none	Unique event gateway ID within this group.
»»» group	string	true	none	Event gateway group name.
»»» organizations	[string]	true	none	Organizations this event gateway serves.
»»» servedOrganizations	[string]	true	none	Organizations this event gateway serves.
»»» contact	string	false	none	The contact information for this event gateway.
»»» lastContact	integer	true	none	Epoch time in ms of the last contact from this gateway.
»»» endpoints	[object]	true	none	Endpoints that the gateway is listening on.
»»»» host	string	true	none	Kafka server host name.
»»»» port	integer	true	none	Kafka server port.
»»»» ssl	boolean	false	none	Connect over SSL.
»»»» certificates	[object]	false	none	Certificates or CAs to trust, required to connect to the server via SSL.
»»»»» pem	string	true	none	Certificate in PEM format
»»»»» subject	string	false	none	Subject name of the certificate
»»»»» sans	[string]	false	none	A list of subject alternative names of the certificate
»»»»» issuer	string	false	none	Issuer of the certificate
»»»»» expiry	integer	false	none	Expiration date of the certificate in epoch millis
»»» version	string	false	none	Version of the gateway.
»»» productVersion	string	false	none	EEM product version.
»»» features	[string]	false	none	Feature set in use by gateway.
»»» deploymentMode	string	false	none	Type of gateway deployment.
»»» capabilities	object	false	none	Description of what capabilities the gateway has.
» collaborators	object	true	none	Collaborators for this endpoint.
»» groups	[string]	true	none	List of groups that collaborate on this event endpoint.
»» contacts	[string]	true	none	List of contacts that collaborate on this event endpoint.

Enumerated Values

Property	Value
type	kafka
encoding	unknown
encoding	text/plain
encoding	application/octet-stream
encoding	application/json
encoding	avro/binary
encoding	avro/json
type	avro
type	json
type	unknown
type	approval
status	pending
status	approved
status	rejected
status	fulfilled
type	redaction
type	replaceString
type	replaceIntegral
type	replaceDouble
type	hash
algorithm	SHA-256
algorithm	SHA-512
type	schema-filtering
type	quota
type	mtls
identificationType	MTLS
identificationType	SASL
type	content-filtering
type	simple
source	body
name	equal
type	string
type	integer
type	double
type	boolean
type	literal
type	reference
value	USER_ID
value	CLIENT_ID

readAllProfileCACertificates

Code samples

# You can also use wget
curl -X GET /admin/profile/ca \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /profile/ca

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The page number of results to retrieve. If this number exceeds the available data, then the last page is returned.
maxPageSize	query	integer	false	The maximum number of entries to return per page. If not specified, all data items are returned.

Example responses

200 Response

[
  {
    "id": "string",
    "subject": "string",
    "issuer": "string",
    "expiry": 0,
    "pem": "string",
    "owned": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	The profile CA certificates for a user.	Inline
400	Bad Request	Invalid request, only one of page and maxPageSize were supplied or max page size exceeded.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	true	none	ID of CA certificate.
» subject	string	true	none	Subject name of the certificate.
» issuer	string	true	none	Issuer of the certificate.
» expiry	integer	true	none	Expiration date of the certificate in epoch milliseconds.
» pem	string	true	none	PEM.
» owned	boolean	true	none	Is the requester the owner of this CA certificate.

Response Headers

Status	Header	Type	Format	Description
200	ei-pagination-total	integer		Total number of items available for retrieval (including current page).

createProfileCACertificate

Code samples

# You can also use wget
curl -X POST /admin/profile/ca \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /profile/ca

Create an author CA certificate.

Body parameter

{
  "trustPem": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringst"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» trustPem	body	string	true	PEM.

Example responses

200 Response

{
  "validCACertificates": [
    {
      "id": "string",
      "pem": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringst",
      "existingCertificate": true
    }
  ],
  "invalidCertificates": [
    {
      "pem": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringst"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	CA certificates successfully processed. Non-CA certificates will be ignored. If the payload contains any previously uploaded CA certificates, then these certificates will not be processed, and the ID of the original CA certificate will be returned in the response.	Inline
400	Bad Request	Bad input.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» validCACertificates	[object]	false	none	Array of all successfully processed CA certificates.
»» id	string	false	none	none
»» pem	string	false	none	PEM.
»» existingCertificate	boolean	false	none	Indicates if the certificate already exists in the store and the existing record was returned.
» invalidCertificates	[object]	false	none	Array of all non CA certificates that were ignored.
»» pem	string	false	none	PEM.

readProfileCACertificate

Code samples

# You can also use wget
curl -X GET /admin/profile/ca/{caId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /profile/ca/{caId}

Parameters

Name	In	Type	Required	Description
caId	path	string	true	The ID of the CA certificate.

Example responses

200 Response

{
  "id": "string",
  "subject": "string",
  "issuer": "string",
  "expiry": 0,
  "pem": "string",
  "owned": true
}

Responses

Status	Meaning	Description	Schema
200	OK	The profile CA certificate for a user.	Inline
304	Not Modified	Data not changed.	None
400	Bad Request	Invalid request, only one of page and maxPageSize were supplied or max page size exceeded.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	true	none	ID of CA certificate.
» subject	string	true	none	Subject name of the certificate.
» issuer	string	true	none	Issuer of the certificate.
» expiry	integer	true	none	Expiration date of the certificate in epoch milliseconds.
» pem	string	true	none	PEM.
» owned	boolean	true	none	Is the requester the owner of this CA certificate.

deleteProfileCACertificate

Code samples

# You can also use wget
curl -X DELETE /admin/profile/ca/{caId} \
  -H 'Authorization: Bearer {access-token}'

DELETE /profile/ca/{caId}

Delete an author CA certificate.

Parameters

Name	In	Type	Required	Description
caId	path	string	true	The ID of the CA certificate to be deleted.

Responses

Status	Meaning	Description	Schema
200	OK	CA certificate deleted successfully.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	CA certificate does not exist.	None
500	Internal Server Error	Internal error.	None

readAllOrgCACertificates

Code samples

# You can also use wget
curl -X GET /admin/organization/ca \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /organization/ca

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The page number of results to retrieve. If this number exceeds the available data, then the last page is returned.
maxPageSize	query	integer	false	The maximum number of entries to return per page. If not specified, all data items are returned.

Example responses

200 Response

[
  {
    "id": "string",
    "subject": "string",
    "issuer": "string",
    "expiry": 0,
    "pem": "string",
    "owned": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	The organization CA certificates.	Inline
304	Not Modified	Data not changed.	None
400	Bad Request	Invalid request, only one of page and maxPageSize were supplied or max page size exceeded.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	true	none	ID of CA certificate.
» subject	string	true	none	Subject name of the certificate.
» issuer	string	true	none	Issuer of the certificate.
» expiry	integer	true	none	Expiration date of the certificate in epoch milliseconds.
» pem	string	true	none	PEM.
» owned	boolean	true	none	Is the requester the owner of this CA certificate.

Response Headers

Status	Header	Type	Format	Description
200	ei-pagination-total	integer		Total number of items available for retrieval (including current page).

createOrgCACertificate

Code samples

# You can also use wget
curl -X POST /admin/organization/ca \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /organization/ca

Create an organization CA certificate.

Body parameter

{
  "trustPem": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringst"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» trustPem	body	string	true	PEM.

Example responses

200 Response

{
  "validCACertificates": [
    {
      "id": "string",
      "pem": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringst",
      "existingCertificate": true
    }
  ],
  "invalidCertificates": [
    {
      "pem": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringst"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Author CA certificate successfully created.	Inline
400	Bad Request	Bad input.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» validCACertificates	[object]	false	none	Array of all successfully processed CA certificates.
»» id	string	false	none	none
»» pem	string	false	none	PEM.
»» existingCertificate	boolean	false	none	Indicates if the certificate already exists in the store and the existing record was returned.
» invalidCertificates	[object]	false	none	Array of all non CA certificates that were ignored.
»» pem	string	false	none	PEM.

readOrgCACertificate

Code samples

# You can also use wget
curl -X GET /admin/organization/ca/{caId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /organization/ca/{caId}

Parameters

Name	In	Type	Required	Description
caId	path	string	true	The ID of the CA certificate.

Example responses

200 Response

{
  "id": "string",
  "subject": "string",
  "issuer": "string",
  "expiry": 0,
  "pem": "string",
  "owned": true
}

Responses

Status	Meaning	Description	Schema
200	OK	The organization CA certificate for a user.	Inline
304	Not Modified	Data not changed.	None
400	Bad Request	Invalid request, only one of page and maxPageSize were supplied or max page size exceeded.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	true	none	ID of CA certificate.
» subject	string	true	none	Subject name of the certificate.
» issuer	string	true	none	Issuer of the certificate.
» expiry	integer	true	none	Expiration date of the certificate in epoch milliseconds.
» pem	string	true	none	PEM.
» owned	boolean	true	none	Is the requester the owner of this CA certificate.

deleteOrgCACertificate

Code samples

# You can also use wget
curl -X DELETE /admin/organization/ca/{caId} \
  -H 'Authorization: Bearer {access-token}'

DELETE /organization/ca/{caId}

Delete an organization CA certificate.

Parameters

Name	In	Type	Required	Description
caId	path	string	true	The ID of the CA certificate to be deleted.

Responses

Status	Meaning	Description	Schema
200	OK	CA certificate deleted successfully.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	CA certificate does not exist.	None
500	Internal Server Error	Internal error.	None

transferOwnership

Code samples

# You can also use wget
curl -X POST /admin/organization/transferOwnership \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /organization/transferOwnership

Transfer ownership of EEM assets from one user to another.

Body parameter

{
  "ownedBy": "string",
  "targetOwner": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» ownedBy	body	string	true	Owner of the assets. The subject to transfer from.
» targetOwner	body	string	true	New owner of the assets. The subject to be transferred to.

Responses

Status	Meaning	Description	Schema
200	OK	Assets successfully transferred.	None
400	Bad Request	Invalid request.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	Requested owners do not exist.	None
409	Conflict	Conflict cannot make transfer between users.	None
500	Internal Server Error	Internal error.	None

readAllUserAssets

Code samples

# You can also use wget
curl -X GET /admin/userassets \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /userassets

List all users and all their assets.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The page number of results to retrieve. If this number exceeds the available data, then the last page is returned.
maxPageSize	query	integer	false	The maximum number of entries to return per page. If not specified, all data items are returned.
includeEmptyUsers	query	string	false	Flag to indicate whether to include users that have no assets. True means return all defined users, whether they have assets or not. Default is false.
search	query	string	false	Given a searched field, filter the response to include only users who match in username or in their subject. For example, topics or virtual topics.

Example responses

200 Response

[
  {
    "userId": "string",
    "preferredUsername": "string",
    "displayName": "string",
    "roles": [
      "string"
    ],
    "assets": {
      "eventsource": 0,
      "cluster": 0,
      "option": 0,
      "subscription": 0,
      "ca": 0,
      "gateway": 0,
      "application": 0
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	List all defined users and their owned assets.	Inline
304	Not Modified	Data not changed.	None
400	Bad Request	Invalid request, only one of page and maxPageSize were supplied or max page size exceeded.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» userId	string	true	none	User identifier.
» preferredUsername	string	true	none	Preferred user name.
» displayName	string	true	none	Display name.
» roles	[string]	true	none	User roles.
» assets	object	true	none	List of the different asset types and the number of instances of that type owned by the user.
»» eventsource	number	true	none	none
»» cluster	number	true	none	none
»» option	number	true	none	none
»» subscription	number	true	none	none
»» ca	number	true	none	none
»» gateway	number	true	none	none
»» application	number	true	none	none

eventEndpointApprovalRequestList

Code samples

# You can also use wget
curl -X GET /admin/eventendpoints/requests \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /eventendpoints/requests

Get all the requests created against virtual topics that this author owns.

Example responses

200 Response

[
  {
    "id": "string",
    "lastUpdated": 0,
    "contact": "string",
    "applicationId": "string",
    "justification": "string",
    "status": "pending",
    "sourceTopic": {
      "id": "string",
      "name": "string"
    },
    "virtualTopic": {
      "id": "string",
      "name": "string"
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	List all pending approval requests that this owner can respond to.	Inline
400	Bad Request	Bad input.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique approval Request ID.
» lastUpdated	integer	false	none	Unix Epoch timestamp of when this approval Request was last updated
» contact	string	true	none	The contact details of the raiser of this approval Request.
» applicationId	string	false	none	The application Id if this request is for an application subscription.
» justification	string	true	none	The justification for this approval Request.
» status	string	true	none	The status of this approval request.
» sourceTopic	object	true	none	Information about the Source Topic this Request is for.
»» id	string	true	none	Unique Source Topic ID.
»» name	string	true	none	Source Topic name.
» virtualTopic	object	true	none	Information about the Virtual Topic this approval Request is for.
»» id	string	true	none	Unique Virtual Topic ID.
»» name	string	true	none	Virtual Topic name.

Enumerated Values

Property	Value
status	pending
status	approved
status	rejected
status	fulfilled

Response Headers

Status	Header	Type	Format	Description
200	etag	string		An identifier that can be supplied with the If-None-Match header to indicate that unchanged results should return 304 with no data.

createEventEndpointApprovalRequest

Code samples

# You can also use wget
curl -X POST /admin/eventendpoints/{eventEndpointId}/requests \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /eventendpoints/{eventEndpointId}/requests

Create a new approval request against this event endpoint.

Body parameter

{
  "description": "string",
  "contact": "string",
  "applicationId": "string"
}

Parameters

Name	In	Type	Required	Description
eventEndpointId	path	string	true	The ID of the event endpoint to create an approval request against.
body	body	object	true	none
» description	body	string	true	Description of why the request was created.
» contact	body	string	true	Contact details of the person making the request.
» applicationId	body	string	false	Optional application ID if this is for an application subscription.

Example responses

200 Response

{
  "id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Event endpoint approval successfully requested.	Inline
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	This event endpoint does not exist.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	true	none	Approval request ID.

updateEventEndpointApprovalRequest

Code samples

# You can also use wget
curl -X PUT /admin/eventendpoints/{eventEndpointId}/requests/{requestId} \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT /eventendpoints/{eventEndpointId}/requests/{requestId}

Update the status of the chosen request.

Body parameter

{
  "status": "pending"
}

Parameters

Name	In	Type	Required	Description
eventEndpointId	path	string	true	The ID of the event endpoint that this request is for.
requestId	path	string	true	The ID of the approval request.
body	body	object	true	none
» status	body	string	true	Status of the request [pending, approved, rejected, fulfilled].

Enumerated Values

Parameter	Value
» status	pending
» status	approved
» status	rejected
» status	fulfilled

Responses

Status	Meaning	Description	Schema
200	OK	Request updated.	None
400	Bad Request	Bad input.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

deleteEventEndpointApprovalRequest

Code samples

# You can also use wget
curl -X DELETE /admin/eventendpoints/{eventEndpointId}/requests/{requestId} \
  -H 'Authorization: Bearer {access-token}'

DELETE /eventendpoints/{eventEndpointId}/requests/{requestId}

Delete the chosen approval request.

Parameters

Name	In	Type	Required	Description
eventEndpointId	path	string	true	The ID of the event endpoint this delete request is for.
requestId	path	string	true	The ID of the approval request this delete request is for.

Responses

Status	Meaning	Description	Schema
200	OK	Approval request deleted.	None
400	Bad Request	Bad input.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

eventEndpointApprovalRequestViewerList

Code samples

# You can also use wget
curl -X GET /admin/requests/user \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /requests/user

Get all approval requests created by this user. This endpoint is now deprecated. Use /applications/requests endpoint instead.

Parameters

Name	In	Type	Required	Description
filterByStatus	query	string	false	Approval status to filter by.

Enumerated Values

Parameter	Value
filterByStatus	pending
filterByStatus	approved
filterByStatus	rejected
filterByStatus	fulfilled

Example responses

200 Response

[
  {
    "id": "string",
    "lastUpdated": 0,
    "contact": "string",
    "applicationId": "string",
    "justification": "string",
    "status": "pending",
    "eventSource": {
      "id": "string",
      "name": "string"
    },
    "eventEndpoint": {
      "id": "string",
      "name": "string"
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	List that contains information about the user’s approval requests.	Inline
400	Bad Request	Bad input.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	Option does not exist.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique approval request ID.
» lastUpdated	integer	false	none	Unix Epoch timestamp of when this approval request was last updated.
» contact	string	true	none	The contact details of the raiser of this approval request.
» applicationId	string	false	none	The applicationID if this request is for an application subscription.
» justification	string	true	none	The justification for this approval request.
» status	string	true	none	The status of this approval request.
» eventSource	object	true	none	Information about the source topic this request is for.
»» id	string	true	none	Unique source topic ID.
»» name	string	true	none	source topic name.
» eventEndpoint	object	true	none	Information about the event endpoint this approval request is for.
»» id	string	true	none	Unique Event Endpoint ID.
»» name	string	true	none	Event Endpoint name.

Enumerated Values

Property	Value
status	pending
status	approved
status	rejected
status	fulfilled

Response Headers

Status	Header	Type	Format	Description
200	etag	string		An identifier that can be supplied with the If-None-Match header to indicate that unchanged results should return 304 with no data.

eventEndpointApprovalRequestAdminList

Code samples

# You can also use wget
curl -X GET /admin/requests/admin \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /requests/admin

Get all the requests created against virtual topics that this author owns. This endpoint is now deprecated. Use /eventendpoints/requests endpoint instead.

Example responses

200 Response

[
  {
    "id": "string",
    "lastUpdated": 0,
    "contact": "string",
    "applicationId": "string",
    "justification": "string",
    "status": "pending",
    "eventSource": {
      "id": "string",
      "name": "string"
    },
    "eventEndpoint": {
      "id": "string",
      "name": "string"
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	List that contains information about requests this owner needs to respond to.	Inline
400	Bad Request	Bad input.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique approval request ID.
» lastUpdated	integer	false	none	Unix Epoch timestamp of when this approval request was last updated.
» contact	string	true	none	The contact details of the raiser of this approval request.
» applicationId	string	false	none	The applicationID if this request is for an application subscription.
» justification	string	true	none	The justification for this approval request.
» status	string	true	none	The status of this approval request.
» eventSource	object	true	none	Information about the source topic this request is for.
»» id	string	true	none	Unique source topic ID.
»» name	string	true	none	source topic name.
» eventEndpoint	object	true	none	Information about the event endpoint this approval request is for.
»» id	string	true	none	Unique Event Endpoint ID.
»» name	string	true	none	Event Endpoint name.

Enumerated Values

Property	Value
status	pending
status	approved
status	rejected
status	fulfilled

Response Headers

Status	Header	Type	Format	Description
200	etag	string		An identifier that can be supplied with the If-None-Match header to indicate that unchanged results should return 304 with no data.

readAllGroups

Code samples

# You can also use wget
curl -X GET /admin/groups \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /groups

List groups for clusters, source topics, and virtual topics.

Parameters

Name	In	Type	Required	Description
exclude	query	string	false	Object type to exclude.

Enumerated Values

Parameter	Value
exclude	options
exclude	clusters
exclude	eventsources

Example responses

200 Response

[
  {
    "name": "string",
    "eventSourceRefs": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "clusterRefs": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "optionRefs": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "applicationRefs": [
      {
        "id": "string",
        "name": "string"
      }
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	List of groups for clusters, source topics, and virtual topics.	Inline
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

List of groups and their source topic, cluster, virtual topic and application references.

Name	Type	Required	Restrictions	Description
» name	string	true	none	none
» eventSourceRefs	[object]	false	none	none
»» id	string	true	none	none
»» name	string	true	none	none
» clusterRefs	[object]	false	none	none
»» id	string	true	none	none
»» name	string	true	none	none
» optionRefs	[object]	false	none	none
»» id	string	true	none	none
»» name	string	true	none	none
» applicationRefs	[object]	false	none	none
»» id	string	true	none	none
»» name	string	true	none	none

createIdpServer

Code samples

# You can also use wget
curl -X POST /admin/idpservers \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /idpservers

Create an IDP server.

Body parameter

{
  "name": "string",
  "type": "OAUTH2",
  "description": "string",
  "userInfoUrl": "http://example.com",
  "introspectionEndpoint": {
    "url": "http://example.com",
    "credentials": {
      "clientId": "string",
      "clientSecret": "string"
    }
  },
  "trustedCertificates": [
    {
      "pem": "string"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» name	body	string	true	Name of the IDP Server.
» type	body	string	true	IDP type.
» description	body	string	false	Description of the IDP Server.
» userInfoUrl	body	string(uri)	false	The userInfo endpoint of the IDP Server (including protocol).
» introspectionEndpoint	body	object	false	The introspection endpoint of the IDP Server.
»» url	body	string(uri)	true	The introspection endpoint of the IDP Server (including protocol).
»» credentials	body	object	true	Credentials for authenticating to access the introspection endpoint.
»»» clientId	body	string	true	none
»»» clientSecret	body	string	true	none
» trustedCertificates	body	[object]	false	Trusted certificates for connecting to endpoints.
»» pem	body	string	true	PEM.
» anonymous	body	object	false	none
» anonymous	body	object	false	none

Enumerated Values

Parameter	Value
» type	OAUTH2

Example responses

200 Response

{
  "id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	IDP server successfully created.	Inline
400	Bad Request	Bad input.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
409	Conflict	IDP server with the specified userInfo URL already exists.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	false	none	The ID of your newly created IDP server.

readAllIdpServers

Code samples

# You can also use wget
curl -X GET /admin/idpservers \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /idpservers

List all IDP servers created by the current user in an organization.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The page number of results to retrieve. If this number exceeds the available data, then the last page is returned.
maxPageSize	query	integer	false	The maximum number of entries to return per page. If not specified, all data items are returned.

Example responses

200 Response

[
  {
    "id": "string",
    "organization": "string",
    "owner": "string",
    "name": "string",
    "type": "OAUTH2",
    "description": "string",
    "userInfoUrl": "http://example.com",
    "introspectionEndpoint": {
      "url": "http://example.com",
      "credentials": {
        "clientId": "string"
      }
    },
    "trustedCertificates": [
      {
        "subject": "string",
        "issuer": "string",
        "expiry": 0,
        "pem": "string"
      }
    ],
    "hasPublishedOptions": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	IDP servers successfully listed.	Inline
400	Bad Request	Invalid request, only one of page and maxPageSize were supplied or max page size exceeded.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique IDP server ID.
» organization	string	true	none	Organization this IDP server belongs to.
» owner	string	true	none	IDP server owner.
» name	string	true	none	Name of the IDP Server.
» type	string	true	none	IDP type.
» description	string	false	none	Description of the IDP Server.
» userInfoUrl	string(uri)	false	none	The userInfo endpoint of the IDP Server (including protocol).
» introspectionEndpoint	object	false	none	The introspection endpoint of the IDP Server.
»» url	string(uri)	true	none	The introspection endpoint of the IDP Server (including protocol).
»» credentials	object	true	none	Credentials for authenticating to access the introspection endpoint.
»»» clientId	string	true	none	none
» trustedCertificates	[object]	false	none	Trusted certificates for connecting to endpoints.
»» subject	string	true	none	Subject name of the certificate.
»» issuer	string	true	none	Issuer of the certificate.
»» expiry	integer	true	none	Expiration date of the certificate in epoch ms.
»» pem	string	true	none	PEM.
» hasPublishedOptions	boolean	true	none	Flag indicating if the IDP Server is being used in published options.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none

Enumerated Values

Property	Value
type	OAUTH2

Response Headers

Status	Header	Type	Format	Description
200	ei-pagination-total	integer		Total number of items available for retrieval (including current page).

readIdpServer

Code samples

# You can also use wget
curl -X GET /admin/idpservers/{idpServerId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /idpservers/{idpServerId}

Parameters

Name	In	Type	Required	Description
idpServerId	path	string	true	The ID of the IDP server.

Example responses

200 Response

{
  "id": "string",
  "organization": "string",
  "owner": "string",
  "name": "string",
  "type": "OAUTH2",
  "description": "string",
  "userInfoUrl": "http://example.com",
  "introspectionEndpoint": {
    "url": "http://example.com",
    "credentials": {
      "clientId": "string"
    }
  },
  "trustedCertificates": [
    {
      "subject": "string",
      "issuer": "string",
      "expiry": 0,
      "pem": "string"
    }
  ],
  "hasPublishedOptions": true
}

Responses

Status	Meaning	Description	Schema
200	OK	The IDP server.	Inline
400	Bad Request	Invalid request, only one of page and maxPageSize were supplied or max page size exceeded.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique IDP server ID.
» organization	string	true	none	Organization this IDP server belongs to.
» owner	string	true	none	IDP server owner.
» name	string	true	none	Name of the IDP Server.
» type	string	true	none	IDP type.
» description	string	false	none	Description of the IDP Server.
» userInfoUrl	string(uri)	false	none	The userInfo endpoint of the IDP Server (including protocol).
» introspectionEndpoint	object	false	none	The introspection endpoint of the IDP Server.
»» url	string(uri)	true	none	The introspection endpoint of the IDP Server (including protocol).
»» credentials	object	true	none	Credentials for authenticating to access the introspection endpoint.
»»» clientId	string	true	none	none
» trustedCertificates	[object]	false	none	Trusted certificates for connecting to endpoints.
»» subject	string	true	none	Subject name of the certificate.
»» issuer	string	true	none	Issuer of the certificate.
»» expiry	integer	true	none	Expiration date of the certificate in epoch ms.
»» pem	string	true	none	PEM.
» hasPublishedOptions	boolean	true	none	Flag indicating if the IDP Server is being used in published options.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none

Enumerated Values

Property	Value
type	OAUTH2

updateIdpServer

Code samples

# You can also use wget
curl -X PUT /admin/idpservers/{idpServerId} \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT /idpservers/{idpServerId}

Update an IDP server.

Body parameter

{
  "name": "string",
  "type": "OAUTH2",
  "description": "string",
  "userInfoUrl": "http://example.com",
  "introspectionEndpoint": {
    "url": "http://example.com",
    "credentials": {
      "clientId": "string",
      "clientSecret": "string"
    }
  },
  "trustedCertificates": [
    {
      "pem": "string"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
idpServerId	path	string	true	The ID of the IDP server to update.
body	body	object	true	IDP server data.
» name	body	string	true	Name of the IDP Server.
» type	body	string	true	IDP type.
» description	body	string	false	Description of the IDP Server.
» userInfoUrl	body	string(uri)	false	The userInfo endpoint of the IDP Server (including protocol).
» introspectionEndpoint	body	object	false	The introspection endpoint of the IDP Server.
»» url	body	string(uri)	true	The introspection endpoint of the IDP Server (including protocol).
»» credentials	body	object	false	Credentials for authenticating to access the introspection endpoint.
»»» clientId	body	string	true	none
»»» clientSecret	body	string	true	none
» trustedCertificates	body	[object]	false	Trusted certificates for connecting to endpoints.
»» pem	body	string	true	PEM.
» anonymous	body	object	false	none
» anonymous	body	object	false	none

Enumerated Values

Parameter	Value
» type	OAUTH2

Responses

Status	Meaning	Description	Schema
200	OK	IDP server successfully updated.	None
400	Bad Request	Bad input.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	IDP server does not exist.	None
409	Conflict	IDP server with the specified userInfo URL already exists.	None
500	Internal Server Error	Internal error.	None

deleteIdpServer

Code samples

# You can also use wget
curl -X DELETE /admin/idpservers/{idpServerId} \
  -H 'Authorization: Bearer {access-token}'

DELETE /idpservers/{idpServerId}

Delete an IDP server

Parameters

Name	In	Type	Required	Description
idpServerId	path	string	true	The ID of the IDP server to be deleted.

Responses

Status	Meaning	Description	Schema
200	OK	IDP server deleted successfully.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	IDP server does not exist.	None
500	Internal Server Error	Internal error.	None

createClientAuthSet

Code samples

# You can also use wget
curl -X POST /admin/clientauthsets \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /clientauthsets

Create a client authentication set.

Body parameter

{
  "controls": [
    "sasl-oauth"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» controls	body	[string]	true	Array of required client authentication controls.

Enumerated Values

Parameter	Value
» controls	sasl-oauth
» controls	sasl-credentials
» controls	mtls

Example responses

200 Response

{
  "id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Client authentication set successfully created.	Inline
400	Bad Request	Bad input.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
409	Conflict	Provided client authentication set has an invalid combination of control types.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	false	none	The ID of your newly created client authentication set.

readAllClientAuthSets

Code samples

# You can also use wget
curl -X GET /admin/clientauthsets \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /clientauthsets

List all client authentication sets created by the current user in an organization.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The page number of results to retrieve. If this number exceeds the available data, then the last page is returned.
maxPageSize	query	integer	false	The maximum number of entries to return per page. If not specified, all data items are returned.

Example responses

200 Response

[
  {
    "id": "string",
    "organization": "string",
    "owner": "string",
    "controls": [
      "sasl-oauth"
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Client authentication sets successfully listed.	Inline
304	Not Modified	Data not changed.	None
400	Bad Request	Invalid request, only one of page and maxPageSize were supplied or max page size exceeded.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique client authentication set ID.
» organization	string	true	none	Organization this client authentication set belongs to.
» owner	string	true	none	Client authentication set owner.
» controls	[string]	true	none	Array of required client authentication controls.

Response Headers

Status	Header	Type	Format	Description
200	ei-pagination-total	integer		Total number of items available for retrieval (including current page).
200	etag	string		An identifier that can be supplied with the If-None-Match header to indicate that unchanged results should return 304 with no data.

readClientAuthSet

Code samples

# You can also use wget
curl -X GET /admin/clientauthsets/{clientAuthSetId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /clientauthsets/{clientAuthSetId}

Parameters

Name	In	Type	Required	Description
clientAuthSetId	path	string	true	The ID of the client authentication set.

Example responses

200 Response

{
  "id": "string",
  "organization": "string",
  "owner": "string",
  "controls": [
    "sasl-oauth"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The client authentication set.	Inline
400	Bad Request	Invalid request, only one of page and maxPageSize were supplied or max page size exceeded.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Set of client authentication controls.

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique client authentication set ID.
» organization	string	true	none	Organization this client authentication set belongs to.
» owner	string	true	none	Client authentication set owner.
» controls	[string]	true	none	Array of required client authentication controls.

deleteClientAuthSet

Code samples

# You can also use wget
curl -X DELETE /admin/clientauthsets/{clientAuthSetId} \
  -H 'Authorization: Bearer {access-token}'

DELETE /clientauthsets/{clientAuthSetId}

Delete a client authentication set

Parameters

Name	In	Type	Required	Description
clientAuthSetId	path	string	true	The ID of the client authentication set to be deleted.

Responses

Status	Meaning	Description	Schema
200	OK	Client authentication set deleted successfully.	None
400	Bad Request	Unable to delete the final client authentication set. There must be at least one present.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	Client authentication set does not exist.	None
500	Internal Server Error	Internal error.	None

readDeveloperPortalMappings

Code samples

# You can also use wget
curl -X GET /admin/developerportal/mappings \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /developerportal/mappings

List all mappings shared with Developer Portal in an organization.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The page number of results to retrieve. If this number exceeds the available data, then the last page is returned.
maxPageSize	query	integer	false	The maximum number of entries to return per page. If not specified, all data items are returned.

Example responses

200 Response

{
  "dpoApiToVirtualTopicIds": [
    {
      "dpoApi": "string",
      "virtualTopicId": {
        "optionId": "string",
        "eventSourceId": "string"
      }
    }
  ],
  "dpoAppToAppIds": [
    {
      "dpoAppId": "string",
      "appId": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Mappings successfully listed.	Inline
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	No mappings exist.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» dpoApiToVirtualTopicIds	[object]	true	none	none
»» dpoApi	string	true	none	none
»» virtualTopicId	object	true	none	none
»»» optionId	string	true	none	none
»»» eventSourceId	string	true	none	none
» dpoAppToAppIds	[object]	true	none	none
»» dpoAppId	string	true	none	none
»» appId	string	true	none	none

Response Headers

Status	Header	Type	Format	Description
200	etag	string		An identifier that can be supplied with the If-None-Match header to indicate that unchanged results should return 304 with no data.

deleteDeveloperPortalMappings

Code samples

# You can also use wget
curl -X DELETE /admin/developerportal/mappings \
  -H 'Authorization: Bearer {access-token}'

DELETE /developerportal/mappings

Delete all mappings that are shared with Developer Portal internally created in an organization.

Responses

Status	Meaning	Description	Schema
200	OK	Application subscriptions deleted successfully.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	No mappings exist.	None
500	Internal Server Error	Internal error.	None

createApplication

Code samples

# You can also use wget
curl -X POST /admin/applications \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /applications

Create an application.

Body parameter

{
  "name": "string",
  "description": "string",
  "contact": "string",
  "collaborators": {
    "groups": [
      "string"
    ]
  },
  "credentials": {
    "MTLS": [
      {
        "subjectCommonName": "string",
        "subjectOrganization": "string",
        "subjectCountry": "string",
        "subjectStateOrProvince": "string",
        "subjectLocality": "string"
      }
    ],
    "SASL": [
      {
        "type": "sasl-credentials",
        "data": {
          "mechanism": "PLAIN"
        }
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» name	body	string	true	The name of the application.
» description	body	string	false	The description of the application.
» contact	body	string	true	A contact for the owner of the application.
» collaborators	body	object	false	none
»» groups	body	[string]	true	List of collaborators for this application.
» credentials	body	object	true	Application credentials used by a client to connect to one or more virtual topics.
»» MTLS	body	[object]	false	Details of the mTLS credentials in the application.
»»» subjectCommonName	body	string	true	Subject Common Name to match on.
»»» subjectOrganization	body	string	false	Subject Organization to match on.
»»» subjectCountry	body	string	false	Subject Country to match on.
»»» subjectStateOrProvince	body	string	false	Subject Region to match on.
»»» subjectLocality	body	string	false	Subject Locality to match on.
»» SASL	body	[anyOf]	false	Details of the SASL credentials in the application.
»»» anonymous	body	object	false	SASL plain credentials a client uses to connect to an event gateway.
»»»» type	body	string	true	The type of SASL Credential.
»»»» data	body	object	true	Credential data.
»»»»» mechanism	body	string	true	SASL mechanism for the credentials.
»»» anonymous	body	object	false	SASL OAuth Subject of the OAuth client that is connecting to an event gateway.
»»»» type	body	string	true	The type of SASL credential.
»»»» data	body	object	true	Credential data.
»»»»» subject	body	string	true	SASL OAuth subject.
»»»»» mechanism	body	string	true	SASL mechanism for the credentials.
»» anonymous	body	object	false	none
»» anonymous	body	object	false	none

Enumerated Values

Parameter	Value
»»»» type	sasl-credentials
»»»»» mechanism	PLAIN
»»»» type	sasl-oauth
»»»»» mechanism	OAUTHBEARER

Example responses

200 Response

{
  "id": "string",
  "organization": "string",
  "owner": "string",
  "name": "string",
  "description": "string",
  "contact": "string",
  "collaborators": {
    "groups": [
      "string"
    ]
  },
  "credentials": {
    "MTLS": [
      {
        "id": "string",
        "subjectCommonName": "string",
        "subjectOrganization": "string",
        "subjectCountry": "string",
        "subjectStateOrProvince": "string",
        "subjectLocality": "string"
      }
    ],
    "SASL": [
      {
        "id": "string",
        "type": "sasl-credentials",
        "data": {
          "username": "string",
          "password": "string",
          "mechanism": "PLAIN"
        }
      }
    ]
  },
  "virtualTopicIds": [
    "string"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Application successfully created.	Inline
400	Bad Request	Bad input.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
409	Conflict	Application could not be created due to a conflict.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Application credentials used by a client to connect to one or more virtual topics.

Name	Type	Required	Restrictions	Description
» id	string	true	none	The id of the application.
» organization	string	false	none	Organization this application belongs to.
» owner	string	false	none	Application owner.
» name	string	true	none	The name of the application.
» description	string	false	none	The description of the application.
» contact	string	true	none	A contact for the owner of the application.
» collaborators	object	false	none	none
»» groups	[string]	true	none	List of collaborators for this application.
» credentials	object	true	none	Application credentials used by a client to connect to one or more virtual topics.
»» MTLS	[object]	false	none	Details of the MTLS credentials in the application.
»»» id	string	true	none	ID for this credential.
»»» subjectCommonName	string	true	none	Subject Common Name to match on.
»»» subjectOrganization	string	false	none	Subject Organization to match on.
»»» subjectCountry	string	false	none	Subject Country to match on.
»»» subjectStateOrProvince	string	false	none	Subject Region to match on.
»»» subjectLocality	string	false	none	Subject Locality to match on.
»» SASL	[anyOf]	false	none	Details of the SASL credentials in the application.

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	SASL plain credentials a client uses to connect to an event gateway. Username and password are generated and returned on create requests. Username only is returned on read requests.
»»»» id	string	true	none	ID for this credential.
»»»» type	string	true	none	The type of SASL credential.
»»»» data	object	true	none	Credential data.
»»»»» username	string	true	none	SASL username to authenticate with an event gateway.
»»»»» password	string	false	none	SASL password to authenticate with an event gateway (present on CREATE only).
»»»»» mechanism	string	true	none	SASL mechanism for the credentials.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	SASL OAuth Subject of the OAuth client that is connecting to an event gateway.
»»»» id	string	true	none	ID for this credential.
»»»» type	string	true	none	The type of SASL credential.
»»»» data	object	true	none	Credential data.
»»»»» subject	string	true	none	SASL OAuth subject.
»»»»» mechanism	string	true	none	SASL mechanism for the credentials.

continued

Name	Type	Required	Restrictions	Description
» virtualTopicIds	[string]	true	none	The list of virtual topic IDs that this application gives access to.

Enumerated Values

Property	Value
type	sasl-credentials
mechanism	PLAIN
type	sasl-oauth

readAllApplications

Code samples

# You can also use wget
curl -X GET /admin/applications \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /applications

List all applications created by the current user in an organization.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The page number of results to retrieve. If this number exceeds the available data, then the last page is returned.
maxPageSize	query	integer	false	The maximum number of entries to return per page. If not specified, all data items are returned.
filterByName	query	string	false	Name prefix to filter by.

Example responses

200 Response

[
  {
    "id": "string",
    "organization": "string",
    "owner": "string",
    "name": "string",
    "description": "string",
    "contact": "string",
    "collaborators": {
      "groups": [
        "string"
      ]
    },
    "credentials": {
      "MTLS": [
        {
          "id": "string",
          "subjectCommonName": "string",
          "subjectOrganization": "string",
          "subjectCountry": "string",
          "subjectStateOrProvince": "string",
          "subjectLocality": "string"
        }
      ],
      "SASL": [
        {
          "id": "string",
          "type": "sasl-credentials",
          "data": {
            "username": "string",
            "password": "string",
            "mechanism": "PLAIN"
          }
        }
      ]
    },
    "virtualTopicIds": [
      "string"
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Applications successfully listed.	Inline
304	Not Modified	Data not changed.	None
400	Bad Request	Invalid request, only one of page and maxPageSize were supplied or max page size exceeded.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	true	none	The id of the application.
» organization	string	false	none	Organization this application belongs to.
» owner	string	false	none	Application owner.
» name	string	true	none	The name of the application.
» description	string	false	none	The description of the application.
» contact	string	true	none	A contact for the owner of the application.
» collaborators	object	false	none	none
»» groups	[string]	true	none	List of collaborators for this application.
» credentials	object	true	none	Application credentials used by a client to connect to one or more virtual topics.
»» MTLS	[object]	false	none	Details of the MTLS credentials in the application.
»»» id	string	true	none	ID for this credential.
»»» subjectCommonName	string	true	none	Subject Common Name to match on.
»»» subjectOrganization	string	false	none	Subject Organization to match on.
»»» subjectCountry	string	false	none	Subject Country to match on.
»»» subjectStateOrProvince	string	false	none	Subject Region to match on.
»»» subjectLocality	string	false	none	Subject Locality to match on.
»» SASL	[anyOf]	false	none	Details of the SASL credentials in the application.

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	SASL plain credentials a client uses to connect to an event gateway. Username and password are generated and returned on create requests. Username only is returned on read requests.
»»»» id	string	true	none	ID for this credential.
»»»» type	string	true	none	The type of SASL credential.
»»»» data	object	true	none	Credential data.
»»»»» username	string	true	none	SASL username to authenticate with an event gateway.
»»»»» password	string	false	none	SASL password to authenticate with an event gateway (present on CREATE only).
»»»»» mechanism	string	true	none	SASL mechanism for the credentials.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	SASL OAuth Subject of the OAuth client that is connecting to an event gateway.
»»»» id	string	true	none	ID for this credential.
»»»» type	string	true	none	The type of SASL credential.
»»»» data	object	true	none	Credential data.
»»»»» subject	string	true	none	SASL OAuth subject.
»»»»» mechanism	string	true	none	SASL mechanism for the credentials.

continued

Name	Type	Required	Restrictions	Description
» virtualTopicIds	[string]	true	none	The list of virtual topic IDs that this application gives access to.

Enumerated Values

Property	Value
type	sasl-credentials
mechanism	PLAIN
type	sasl-oauth

Response Headers

Status	Header	Type	Format	Description
200	ei-pagination-total	integer		Total number of items available for retrieval (including current page).
200	etag	string		An identifier that can be supplied with the If-None-Match header to indicate that unchanged results should return 304 with no data.

readApplication

Code samples

# You can also use wget
curl -X GET /admin/applications/{applicationId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /applications/{applicationId}

Parameters

Name	In	Type	Required	Description
applicationId	path	string	true	The ID of the application.

Example responses

200 Response

{
  "id": "string",
  "organization": "string",
  "owner": "string",
  "name": "string",
  "description": "string",
  "contact": "string",
  "collaborators": {
    "groups": [
      "string"
    ]
  },
  "credentials": {
    "MTLS": [
      {
        "id": "string",
        "subjectCommonName": "string",
        "subjectOrganization": "string",
        "subjectCountry": "string",
        "subjectStateOrProvince": "string",
        "subjectLocality": "string"
      }
    ],
    "SASL": [
      {
        "id": "string",
        "type": "sasl-credentials",
        "data": {
          "username": "string",
          "password": "string",
          "mechanism": "PLAIN"
        }
      }
    ]
  },
  "virtualTopicIds": [
    "string"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The application.	Inline
400	Bad Request	Invalid request, only one of page and maxPageSize were supplied or max page size exceeded.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	Application does not exist.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Application credentials used by a client to connect to one or more virtual topics.

Name	Type	Required	Restrictions	Description
» id	string	true	none	The id of the application.
» organization	string	false	none	Organization this application belongs to.
» owner	string	false	none	Application owner.
» name	string	true	none	The name of the application.
» description	string	false	none	The description of the application.
» contact	string	true	none	A contact for the owner of the application.
» collaborators	object	false	none	none
»» groups	[string]	true	none	List of collaborators for this application.
» credentials	object	true	none	Application credentials used by a client to connect to one or more virtual topics.
»» MTLS	[object]	false	none	Details of the MTLS credentials in the application.
»»» id	string	true	none	ID for this credential.
»»» subjectCommonName	string	true	none	Subject Common Name to match on.
»»» subjectOrganization	string	false	none	Subject Organization to match on.
»»» subjectCountry	string	false	none	Subject Country to match on.
»»» subjectStateOrProvince	string	false	none	Subject Region to match on.
»»» subjectLocality	string	false	none	Subject Locality to match on.
»» SASL	[anyOf]	false	none	Details of the SASL credentials in the application.

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	SASL plain credentials a client uses to connect to an event gateway. Username and password are generated and returned on create requests. Username only is returned on read requests.
»»»» id	string	true	none	ID for this credential.
»»»» type	string	true	none	The type of SASL credential.
»»»» data	object	true	none	Credential data.
»»»»» username	string	true	none	SASL username to authenticate with an event gateway.
»»»»» password	string	false	none	SASL password to authenticate with an event gateway (present on CREATE only).
»»»»» mechanism	string	true	none	SASL mechanism for the credentials.

or

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	SASL OAuth Subject of the OAuth client that is connecting to an event gateway.
»»»» id	string	true	none	ID for this credential.
»»»» type	string	true	none	The type of SASL credential.
»»»» data	object	true	none	Credential data.
»»»»» subject	string	true	none	SASL OAuth subject.
»»»»» mechanism	string	true	none	SASL mechanism for the credentials.

continued

Name	Type	Required	Restrictions	Description
» virtualTopicIds	[string]	true	none	The list of virtual topic IDs that this application gives access to.

Enumerated Values

Property	Value
type	sasl-credentials
mechanism	PLAIN
type	sasl-oauth

updateApplication

Code samples

# You can also use wget
curl -X PUT /admin/applications/{applicationId} \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT /applications/{applicationId}

Update an application.

Body parameter

{
  "name": "string",
  "description": "string",
  "contact": "string",
  "collaborators": {
    "groups": [
      "string"
    ]
  }
}

Parameters

Name	In	Type	Required	Description
applicationId	path	string	true	The ID of the application.
body	body	object	true	Application data.
» name	body	string	true	The name of the application.
» description	body	string	false	The description of the application.
» contact	body	string	true	A contact for the owner of the application.
» collaborators	body	object	false	none
»» groups	body	[string]	true	List of collaborators for this application.

Responses

Status	Meaning	Description	Schema
200	OK	Application successfully updated.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	Application does not exist.	None
409	Conflict	Application name already in use.	None
500	Internal Server Error	Internal error.	None

deleteApplication

Code samples

# You can also use wget
curl -X DELETE /admin/applications/{applicationId} \
  -H 'Authorization: Bearer {access-token}'

DELETE /applications/{applicationId}

Delete an application

Parameters

Name	In	Type	Required	Description
applicationId	path	string	true	The ID of the application.

Responses

Status	Meaning	Description	Schema
200	OK	Application deleted successfully.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	Application does not exist.	None
500	Internal Server Error	Internal error.	None

applicationApprovalRequestList

Code samples

# You can also use wget
curl -X GET /admin/applications/requests \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /applications/requests

Get all approval requests for all applications owned by this user.

Parameters

Name	In	Type	Required	Description
filterByStatus	query	string	false	Approval status to filter by.

Enumerated Values

Parameter	Value
filterByStatus	pending
filterByStatus	approved
filterByStatus	rejected
filterByStatus	fulfilled

Example responses

200 Response

[
  {
    "id": "string",
    "lastUpdated": 0,
    "contact": "string",
    "applicationId": "string",
    "justification": "string",
    "status": "pending",
    "sourceTopic": {
      "id": "string",
      "name": "string"
    },
    "virtualTopic": {
      "id": "string",
      "name": "string"
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	List that contains information about the user’s approval requests.	Inline
400	Bad Request	Bad input.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	Option does not exist.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	true	none	Unique approval Request ID.
» lastUpdated	integer	false	none	Unix Epoch timestamp of when this approval Request was last updated
» contact	string	true	none	The contact details of the raiser of this approval Request.
» applicationId	string	false	none	The application Id if this request is for an application subscription.
» justification	string	true	none	The justification for this approval Request.
» status	string	true	none	The status of this approval request.
» sourceTopic	object	true	none	Information about the Source Topic this Request is for.
»» id	string	true	none	Unique Source Topic ID.
»» name	string	true	none	Source Topic name.
» virtualTopic	object	true	none	Information about the Virtual Topic this approval Request is for.
»» id	string	true	none	Unique Virtual Topic ID.
»» name	string	true	none	Virtual Topic name.

Enumerated Values

Property	Value
status	pending
status	approved
status	rejected
status	fulfilled

Response Headers

Status	Header	Type	Format	Description
200	etag	string		An identifier that can be supplied with the If-None-Match header to indicate that unchanged results should return 304 with no data.

createApplicationCredentials

Code samples

# You can also use wget
curl -X POST /admin/applications/{applicationId}/credentials \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /applications/{applicationId}/credentials

Create application credentials.

Body parameter

{
  "MTLS": [
    {
      "subjectCommonName": "string",
      "subjectOrganization": "string",
      "subjectCountry": "string",
      "subjectStateOrProvince": "string",
      "subjectLocality": "string"
    }
  ],
  "SASL": [
    {
      "type": "sasl-credentials",
      "data": {
        "mechanism": "PLAIN"
      }
    }
  ]
}

Parameters

Name	In	Type	Required	Description
applicationId	path	string	true	The ID of the application.
body	body	object	true	none
» MTLS	body	[object]	false	Details of the mTLS credentials in the application.
»» subjectCommonName	body	string	true	Subject Common Name to match on.
»» subjectOrganization	body	string	false	Subject Organization to match on.
»» subjectCountry	body	string	false	Subject Country to match on.
»» subjectStateOrProvince	body	string	false	Subject Region to match on.
»» subjectLocality	body	string	false	Subject Locality to match on.
» SASL	body	[anyOf]	false	Details of the SASL credentials in the application.
»» anonymous	body	object	false	SASL plain credentials a client uses to connect to an event gateway.
»»» type	body	string	true	The type of SASL Credential.
»»» data	body	object	true	Credential data.
»»»» mechanism	body	string	true	SASL mechanism for the credentials.
»» anonymous	body	object	false	SASL OAuth Subject of the OAuth client that is connecting to an event gateway.
»»» type	body	string	true	The type of SASL credential.
»»» data	body	object	true	Credential data.
»»»» subject	body	string	true	SASL OAuth subject.
»»»» mechanism	body	string	true	SASL mechanism for the credentials.
» anonymous	body	object	false	none
» anonymous	body	object	false	none

Enumerated Values

Parameter	Value
»»» type	sasl-credentials
»»»» mechanism	PLAIN
»»» type	sasl-oauth
»»»» mechanism	OAUTHBEARER

Example responses

200 Response

{
  "MTLS": [
    {
      "id": "string",
      "subjectCommonName": "string",
      "subjectOrganization": "string",
      "subjectCountry": "string",
      "subjectStateOrProvince": "string",
      "subjectLocality": "string"
    }
  ],
  "SASL": [
    {
      "id": "string",
      "type": "sasl-credentials",
      "data": {
        "username": "string",
        "password": "string",
        "mechanism": "PLAIN"
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Application credentials successfully created.	Inline
400	Bad Request	Bad input.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Application credentials used by a client to connect to one or more virtual topics.

Name	Type	Required	Restrictions	Description
» MTLS	[object]	false	none	Details of the MTLS credentials in the application.
»» id	string	true	none	ID for this credential.
»» subjectCommonName	string	true	none	Subject Common Name to match on.
»» subjectOrganization	string	false	none	Subject Organization to match on.
»» subjectCountry	string	false	none	Subject Country to match on.
»» subjectStateOrProvince	string	false	none	Subject Region to match on.
»» subjectLocality	string	false	none	Subject Locality to match on.
» SASL	[anyOf]	false	none	Details of the SASL credentials in the application.

anyOf

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	SASL plain credentials a client uses to connect to an event gateway. Username and password are generated and returned on create requests. Username only is returned on read requests.
»»» id	string	true	none	ID for this credential.
»»» type	string	true	none	The type of SASL credential.
»»» data	object	true	none	Credential data.
»»»» username	string	true	none	SASL username to authenticate with an event gateway.
»»»» password	string	false	none	SASL password to authenticate with an event gateway (present on CREATE only).
»»»» mechanism	string	true	none	SASL mechanism for the credentials.

or

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	SASL OAuth Subject of the OAuth client that is connecting to an event gateway.
»»» id	string	true	none	ID for this credential.
»»» type	string	true	none	The type of SASL credential.
»»» data	object	true	none	Credential data.
»»»» subject	string	true	none	SASL OAuth subject.
»»»» mechanism	string	true	none	SASL mechanism for the credentials.

Enumerated Values

Property	Value
type	sasl-credentials
mechanism	PLAIN
type	sasl-oauth

deleteApplicationCredentials

Code samples

# You can also use wget
curl -X DELETE /admin/applications/{applicationId}/credentials/{credentialsId} \
  -H 'Authorization: Bearer {access-token}'

DELETE /applications/{applicationId}/credentials/{credentialsId}

Delete application credentials

Parameters

Name	In	Type	Required	Description
applicationId	path	string	true	The ID of the application.
credentialsId	path	string	true	The ID of the application credentials.

Responses

Status	Meaning	Description	Schema
200	OK	Application credential deleted successfully.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	Application or application credential does not exist.	None
500	Internal Server Error	Internal error.	None

createApplicationSubscription

Code samples

# You can also use wget
curl -X POST /admin/applications/{applicationId}/subscriptions \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /applications/{applicationId}/subscriptions

Create an application subscription.

Body parameter

{
  "virtualTopicId": "string"
}

Parameters

Name	In	Type	Required	Description
applicationId	path	string	true	The ID of the application.
body	body	object	true	none
» virtualTopicId	body	string	true	The ID of the virtual topic the application subscription is for.

Responses

Status	Meaning	Description	Schema
200	OK	Application subscription created successfully.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
409	Conflict	Application subscription already exists.	None
500	Internal Server Error	Internal error.	None

deleteApplicationSubscription

Code samples

# You can also use wget
curl -X DELETE /admin/applications/{applicationId}/subscriptions/{virtualTopicId} \
  -H 'Authorization: Bearer {access-token}'

DELETE /applications/{applicationId}/subscriptions/{virtualTopicId}

Delete an application subscription

Parameters

Name	In	Type	Required	Description
applicationId	path	string	true	The ID of the application.
virtualTopicId	path	string	true	The ID of the virtual topic.

Responses

Status	Meaning	Description	Schema
200	OK	Application subscription deleted successfully.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	Application subscription does not exist.	None
500	Internal Server Error	Internal error.	None

listApplicationSubscriptionApprovalRequests

Code samples

# You can also use wget
curl -X GET /admin/applications/{applicationId}/requests \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /applications/{applicationId}/requests

Get all approval requests for an application.

Parameters

Name	In	Type	Required	Description
applicationId	path	string	true	The ID of the application.

Example responses

200 Response

[
  {
    "justification": "string",
    "contact": "string",
    "virtualTopicId": "string",
    "status": "pending"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Application approval requests read successfully.	Inline
400	Bad Request	Unable to list approval requests for this application.	None
401	Unauthorized	Not authorized, successful login required.	None
403	Forbidden	Access denied for this user or role.	None
404	Not Found	This application does not exist.	None
500	Internal Server Error	Internal error.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» justification	string	false	none	Justification of why the request was made.
» contact	string	true	none	Contact details of the person making the request.
» virtualTopicId	string	true	none	The virtual topic ID that this approval request is for.
» status	string	true	none	Status of the request [pending, approved, rejected, fulfilled].

Enumerated Values

Property	Value
status	pending
status	approved
status	rejected
status	fulfilled

Response Headers

Status	Header	Type	Format	Description
200	ei-pagination-total	integer		Total number of items available for retrieval (including current page).
200	etag	string		An identifier that can be supplied with the If-None-Match header to indicate that unchanged results should return 304 with no data.