Cisco AMP for Endpoints API

PATCH /v1/event_streams/{:id}

Description

Updates an active event stream resource

Show Response Fields

Name Type Description
version String
metadata.links.self String
data.id Integer
data.name String
data.amqp_credentials.user_name String
data.amqp_credentials.password String
data.amqp_credentials.queue_name String
data.amqp_credentials.host String
data.amqp_credentials.port String
data.amqp_credentials.proto String
Write
Preview
Auto Generate

Examples

Updates event stream to a given event_type
Updates event stream to a given list of event_types
Updates event stream to a given group
Updates event_stream to a given list of groups
Updates event_stream to a given name

Updates event stream to a given event_type

Request

Requires Authorization 
PATCH /v1/event_streams/30098
Headers
accept: application/json
content-type: application/json
accept-encoding: identity
authorization: Basic FILTERED
content-length: 27

cURL Edit, then copy and paste on your terminal

curl -X PATCH \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-H 'accept-encoding: identity' \
-H 'content-length: 27' \
--compressed -H 'Accept-Encoding: gzip, deflate' \
-d '{"event_type":[1090519054]}' \
-u YOUR_API_CLIENT_ID \
'https://api.amp.cisco.com/v1/event_streams/30098'
Body
{"event_type":[1090519054]}

Response

Shortened for readability 

content-type: application/json
transfer-encoding: chunked
status: 202 Accepted
x-ratelimit-limit: 3000
x-ratelimit-reset: 890
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
x-ratelimit-remaining: 2833
x-permitted-cross-domain-policies: none
x-download-options: noopen
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2022-03-18T11:55:11Z

{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.amp.cisco.com/v1/event_streams/30098"
    }
  },
  "data": {
    "id": 30098,
    "name": "dBoEkqNI",
    "group_guids": [
      "a4a983ef-91df-428f-9b08-1e88ec5357df"
    ],
    "event_types": [
      1090519054
    ],
    "amqp_credentials": {
      "user_name": "30098-16db5cf986eec6f44422",
      "queue_name": "event_stream_30098",
      "host": "export-streaming-lb-int.qa1.immunet.com",
      "port": "443",
      "proto": "amqps"
    }
  }
}

Updates event stream to a given list of event_types

Request

Requires Authorization 
PATCH /v1/event_streams/30098
Headers
accept: application/json
content-type: application/json
accept-encoding: identity
authorization: Basic FILTERED
content-length: 37

cURL Edit, then copy and paste on your terminal

curl -X PATCH \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-H 'accept-encoding: identity' \
-H 'content-length: 37' \
--compressed -H 'Accept-Encoding: gzip, deflate' \
-d '{"event_type":[1090519054,554696714]}' \
-u YOUR_API_CLIENT_ID \
'https://api.amp.cisco.com/v1/event_streams/30098'
Body
{"event_type":[1090519054,554696714]}

Response

Shortened for readability 

content-type: application/json
transfer-encoding: chunked
status: 202 Accepted
x-ratelimit-limit: 3000
x-ratelimit-reset: 889
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
x-ratelimit-remaining: 2832
x-permitted-cross-domain-policies: none
x-download-options: noopen
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2022-03-18T11:55:11Z

{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.amp.cisco.com/v1/event_streams/30098"
    }
  },
  "data": {
    "id": 30098,
    "name": "dBoEkqNI",
    "group_guids": [
      "a4a983ef-91df-428f-9b08-1e88ec5357df"
    ],
    "event_types": [
      1090519054,
      554696714
    ],
    "amqp_credentials": {
      "user_name": "30098-16db5cf986eec6f44422",
      "queue_name": "event_stream_30098",
      "host": "export-streaming-lb-int.qa1.immunet.com",
      "port": "443",
      "proto": "amqps"
    }
  }
}

Updates event stream to a given group

Request

Requires Authorization 
PATCH /v1/event_streams/30098
Headers
accept: application/json
content-type: application/json
accept-encoding: identity
authorization: Basic FILTERED
content-length: 55

cURL Edit, then copy and paste on your terminal

curl -X PATCH \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-H 'accept-encoding: identity' \
-H 'content-length: 55' \
--compressed -H 'Accept-Encoding: gzip, deflate' \
-d '{"group_guid":["a4a983ef-91df-428f-9b08-1e88ec5357df"]}' \
-u YOUR_API_CLIENT_ID \
'https://api.amp.cisco.com/v1/event_streams/30098'
Body
{"group_guid":["a4a983ef-91df-428f-9b08-1e88ec5357df"]}

Response

Shortened for readability 

content-type: application/json
transfer-encoding: chunked
status: 202 Accepted
x-ratelimit-limit: 3000
x-ratelimit-reset: 888
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
x-ratelimit-remaining: 2831
x-permitted-cross-domain-policies: none
x-download-options: noopen
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2022-03-18T11:55:11Z

{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.amp.cisco.com/v1/event_streams/30098"
    }
  },
  "data": {
    "id": 30098,
    "name": "dBoEkqNI",
    "group_guids": [
      "a4a983ef-91df-428f-9b08-1e88ec5357df"
    ],
    "event_types": [
      554696714,
      1090519054
    ],
    "amqp_credentials": {
      "user_name": "30098-16db5cf986eec6f44422",
      "queue_name": "event_stream_30098",
      "host": "export-streaming-lb-int.qa1.immunet.com",
      "port": "443",
      "proto": "amqps"
    }
  }
}

Updates event_stream to a given list of groups

Request

Requires Authorization 
PATCH /v1/event_streams/30098
Headers
accept: application/json
content-type: application/json
accept-encoding: identity
authorization: Basic FILTERED
content-length: 94

cURL Edit, then copy and paste on your terminal

curl -X PATCH \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-H 'accept-encoding: identity' \
-H 'content-length: 94' \
--compressed -H 'Accept-Encoding: gzip, deflate' \
-d '{"group_guid":["a4a983ef-91df-428f-9b08-1e88ec5357df","717e9847-316b-4441-ae3f-1b1950dc67bb"]}' \
-u YOUR_API_CLIENT_ID \
'https://api.amp.cisco.com/v1/event_streams/30098'
Body
{"group_guid":["a4a983ef-91df-428f-9b08-1e88ec5357df","717e9847-316b-4441-ae3f-1b1950dc67bb"]}

Response

Shortened for readability 

content-type: application/json
transfer-encoding: chunked
status: 202 Accepted
x-ratelimit-limit: 3000
x-ratelimit-reset: 887
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
x-ratelimit-remaining: 2830
x-permitted-cross-domain-policies: none
x-download-options: noopen
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2022-03-18T11:55:11Z

{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.amp.cisco.com/v1/event_streams/30098"
    }
  },
  "data": {
    "id": 30098,
    "name": "dBoEkqNI",
    "group_guids": [
      "a4a983ef-91df-428f-9b08-1e88ec5357df",
      "717e9847-316b-4441-ae3f-1b1950dc67bb"
    ],
    "event_types": [
      554696714,
      1090519054
    ],
    "amqp_credentials": {
      "user_name": "30098-16db5cf986eec6f44422",
      "queue_name": "event_stream_30098",
      "host": "export-streaming-lb-int.qa1.immunet.com",
      "port": "443",
      "proto": "amqps"
    }
  }
}

Updates event_stream to a given name

Request

Requires Authorization 
PATCH /v1/event_streams/30098
Headers
accept: application/json
content-type: application/json
accept-encoding: identity
authorization: Basic FILTERED
content-length: 19

cURL Edit, then copy and paste on your terminal

curl -X PATCH \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-H 'accept-encoding: identity' \
-H 'content-length: 19' \
--compressed -H 'Accept-Encoding: gzip, deflate' \
-d '{"name":"meLoDwrX"}' \
-u YOUR_API_CLIENT_ID \
'https://api.amp.cisco.com/v1/event_streams/30098'
Body
{"name":"meLoDwrX"}

Response

Shortened for readability 

content-type: application/json
transfer-encoding: chunked
status: 202 Accepted
x-ratelimit-limit: 3000
x-ratelimit-reset: 886
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
x-ratelimit-remaining: 2829
x-permitted-cross-domain-policies: none
x-download-options: noopen
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2022-03-18T11:55:11Z

{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.amp.cisco.com/v1/event_streams/30098"
    }
  },
  "data": {
    "id": 30098,
    "name": "meLoDwrX",
    "group_guids": [
      "717e9847-316b-4441-ae3f-1b1950dc67bb",
      "a4a983ef-91df-428f-9b08-1e88ec5357df"
    ],
    "event_types": [
      554696714,
      1090519054
    ],
    "amqp_credentials": {
      "user_name": "30098-16db5cf986eec6f44422",
      "queue_name": "event_stream_30098",
      "host": "export-streaming-lb-int.qa1.immunet.com",
      "port": "443",
      "proto": "amqps"
    }
  }
}