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 name
Updates event stream to a given group

Updates event stream to a given event_type

Request

Requires Authorization 
PATCH /v1/event_streams/3952
Headers
accept: application/json
content-type: application/json
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 '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/3952'
Body
{"event_type":[1090519054]}

Response

Shortened for readability 

x-ratelimit-limit: 3000
x-ratelimit-reset: 3329
x-ratelimit-remaining: 2888
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2017-08-18T03:52:38Z
strict-transport-security: max-age=31536000
status: 202 Accepted
transfer-encoding: chunked
content-type: application/json; charset=utf-8

{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.amp.cisco.com/v1/event_streams/3952"
    }
  },
  "data": {
    "id": 3952,
    "name": "fireamp-api-doc-stream",
    "amqp_credentials": {
      "user_name": "3952-16db5cf986eec6f44422",
      "password": "e42d6f2a38118d6d4aedcad4488d606c33295a54",
      "queue_name": "event_stream_3952",
      "host": "export-streaming-lb1-int.qa1.immunet.com",
      "port": "443",
      "proto": "https"
    }
  }
}

Updates event_stream to a given name

Request

Requires Authorization 
PATCH /v1/event_streams/3952
Headers
accept: application/json
content-type: application/json
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 'content-length: 19' \
--compressed -H 'Accept-Encoding: gzip, deflate' \
-d '{"name":"yqdjhXSR"}' \
-u YOUR_API_CLIENT_ID \
'https://api.amp.cisco.com/v1/event_streams/3952'
Body
{"name":"yqdjhXSR"}

Response

Shortened for readability 

x-ratelimit-limit: 3000
x-ratelimit-reset: 3326
x-ratelimit-remaining: 2886
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2017-08-18T03:52:38Z
strict-transport-security: max-age=31536000
status: 202 Accepted
transfer-encoding: chunked
content-type: application/json; charset=utf-8

{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.amp.cisco.com/v1/event_streams/3952"
    }
  },
  "data": {
    "id": 3952,
    "name": "yqdjhXSR",
    "amqp_credentials": {
      "user_name": "3952-16db5cf986eec6f44422",
      "password": "e42d6f2a38118d6d4aedcad4488d606c33295a54",
      "queue_name": "event_stream_3952",
      "host": "export-streaming-lb1-int.qa1.immunet.com",
      "port": "443",
      "proto": "https"
    }
  }
}

Updates event stream to a given group

Request

Requires Authorization 
PATCH /v1/event_streams/25374
Headers
accept: application/json
content-type: application/json
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 'content-length: 55' \
--compressed -H 'Accept-Encoding: gzip, deflate' \
-d '{"group_guid":["67b5e432-1d8c-4a1c-9208-17d2c797e318"]}' \
-u YOUR_API_CLIENT_ID \
'https://api.amp.cisco.com/v1/event_streams/25374'
Body
{"group_guid":["67b5e432-1d8c-4a1c-9208-17d2c797e318"]}

Response

Shortened for readability 

strict-transport-security: max-age=31536000
content-type: application/json; charset=utf-8
status: 202 Accepted
x-ratelimit-limit: 3000
x-ratelimit-reset: 2192
x-ratelimit-remaining: 2638
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2018-10-03T17:33:35Z
transfer-encoding: chunked

{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.amp.cisco.com/v1/event_streams/25374"
    }
  },
  "data": {
    "id": 25374,
    "name": "kayEYiUn",
    "group_guids": [
      "67b5e432-1d8c-4a1c-9208-17d2c797e318"
    ],
    "event_types": [
      1090519054
    ],
    "amqp_credentials": {
      "user_name": "25374-16db5cf986eec6f44422",
      "password": "6e320fa3768883f784742b2585ad16fe677b4f0c",
      "queue_name": "event_stream_25374",
      "host": "export-streaming-lb-int.qa1.immunet.com",
      "port": "443",
      "proto": "https"
    }
  }
}