Integrations Response

List Response Integrations

get

Returns an array of response integrations.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of Response Integrations Requested, or an array containing the new/updated Response Integration after a Create or Update operation.

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

get

/api/v1/integrations/response

HTTPcURLJavaScriptPython

GET /api/v1/integrations/response HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "adapter": "bgp",
      "name": "text",
      "description": "text",
      "config": {
        "expiration": 3600,
        "community": "65534:999",
        "factors": [
          "srcip"
        ],
        "max": 0,
        "neighbors": [
          "96.91.123.225-96.91.123.226"
        ],
        "nexthop": "192.0.2.1",
        "whitelist": [
          "96.91.123.225"
        ]
      }
    }
  ]
}

Create Response Integration

post

Creates a response integration from the data that's been supplied. Do not provide an id. IDs are auto generated

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptional

List of Response Integrations Requested, or an array containing the new/updated Context Integration after a Create or Update operation.

Responses

201

List of Response Integrations Requested, or an array containing the new/updated Response Integration after a Create or Update operation.

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

post

/api/v1/integrations/response

HTTPcURLJavaScriptPython

POST /api/v1/integrations/response HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 229

{
  "adapter": "bgp",
  "name": "text",
  "description": "text",
  "config": {
    "expiration": 3600,
    "community": "65534:999",
    "factors": [
      "srcip"
    ],
    "max": 0,
    "neighbors": [
      "96.91.123.225-96.91.123.226"
    ],
    "nexthop": "192.0.2.1",
    "whitelist": [
      "96.91.123.225"
    ]
  }
}

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "adapter": "bgp",
      "name": "text",
      "description": "text",
      "config": {
        "expiration": 3600,
        "community": "65534:999",
        "factors": [
          "srcip"
        ],
        "max": 0,
        "neighbors": [
          "96.91.123.225-96.91.123.226"
        ],
        "nexthop": "192.0.2.1",
        "whitelist": [
          "96.91.123.225"
        ]
      }
    }
  ]
}

Test a Response Integration Configuration

post

Tests the supplied Response Integration configuration.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptional

List of Response Integrations Requested, or an array containing the new/updated Context Integration after a Create or Update operation.

Responses

201

List of Response Integrations Requested, or an array containing the new/updated Response Integration after a Create or Update operation.

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

post

/api/v1/integrations/response/test

HTTPcURLJavaScriptPython

POST /api/v1/integrations/response/test HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 229

{
  "adapter": "bgp",
  "name": "text",
  "description": "text",
  "config": {
    "expiration": 3600,
    "community": "65534:999",
    "factors": [
      "srcip"
    ],
    "max": 0,
    "neighbors": [
      "96.91.123.225-96.91.123.226"
    ],
    "nexthop": "192.0.2.1",
    "whitelist": [
      "96.91.123.225"
    ]
  }
}

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "adapter": "bgp",
      "name": "text",
      "description": "text",
      "config": {
        "expiration": 3600,
        "community": "65534:999",
        "factors": [
          "srcip"
        ],
        "max": 0,
        "neighbors": [
          "96.91.123.225-96.91.123.226"
        ],
        "nexthop": "192.0.2.1",
        "whitelist": [
          "96.91.123.225"
        ]
      }
    }
  ]
}

Fetch Response Integration

get

Fetches a specific response integration from the ID supplied in the path.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The ID of the response integration to be returned.

Responses

200

List of Response Integrations Requested, or an array containing the new/updated Response Integration after a Create or Update operation.

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

get

/api/v1/integrations/response/{id}

HTTPcURLJavaScriptPython

GET /api/v1/integrations/response/{id} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "adapter": "bgp",
      "name": "text",
      "description": "text",
      "config": {
        "expiration": 3600,
        "community": "65534:999",
        "factors": [
          "srcip"
        ],
        "max": 0,
        "neighbors": [
          "96.91.123.225-96.91.123.226"
        ],
        "nexthop": "192.0.2.1",
        "whitelist": [
          "96.91.123.225"
        ]
      }
    }
  ]
}

Update Response Integration

put

Update a response integration given the provided object. This does not do a diff. You must send the complete object.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The ID of the response integration to be updated

Body

application/json

objectOptional

List of Response Integrations Requested, or an array containing the new/updated Context Integration after a Create or Update operation.

Responses

200

List of Response Integrations Requested, or an array containing the new/updated Response Integration after a Create or Update operation.

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

put

/api/v1/integrations/response/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/integrations/response/{id} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 229

{
  "adapter": "bgp",
  "name": "text",
  "description": "text",
  "config": {
    "expiration": 3600,
    "community": "65534:999",
    "factors": [
      "srcip"
    ],
    "max": 0,
    "neighbors": [
      "96.91.123.225-96.91.123.226"
    ],
    "nexthop": "192.0.2.1",
    "whitelist": [
      "96.91.123.225"
    ]
  }
}

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "adapter": "bgp",
      "name": "text",
      "description": "text",
      "config": {
        "expiration": 3600,
        "community": "65534:999",
        "factors": [
          "srcip"
        ],
        "max": 0,
        "neighbors": [
          "96.91.123.225-96.91.123.226"
        ],
        "nexthop": "192.0.2.1",
        "whitelist": [
          "96.91.123.225"
        ]
      }
    }
  ]
}

Delete Response Integration

delete

Deletes a response integration

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The ID of the response integration to be deleted

Responses

204

An empty array

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

delete

/api/v1/integrations/response/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/integrations/response/{id} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content