For the complete documentation index, see llms.txt. This page is also available as Markdown.

Integrations Context

List Context Integrations

get

Returns an array of context integrations.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

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

application/json
get/api/v1/integrations/context
GET /api/v1/integrations/context HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "id": "text",
      "created": "text",
      "lastupdated": "text",
      "allOf": {
        "name": "text",
        "type": "aws",
        "enabled": true,
        "updateinterval": 86400,
        "aws": {
          "region": "us-east-1",
          "tags": [
            "tag1",
            "tag2"
          ],
          "awsauthtype": "AccessKey",
          "accesskeyid": "text",
          "accesssecret": "text",
          "role": {
            "arn": "arn:aws:iam::464179634201:role/Extension"
          }
        },
        "azure": {
          "clientid": "text",
          "clientsecret": "text",
          "subscriptionid": "text",
          "tenantid": "text",
          "tags": [
            "tag1",
            "tag2"
          ]
        },
        "crowdstrike": {
          "clientid": "text",
          "clientsecret": "text",
          "cloud": "us-1",
          "filter": "text",
          "sort": "text"
        },
        "crowdstrikediscover": {
          "clientid": "text",
          "clientsecret": "text",
          "cloud": "us-1",
          "filter": "text",
          "sort": "text"
        },
        "ibm": {
          "apikey": "text",
          "region": "text"
        },
        "oracle": {
          "user": "text",
          "tenancy": "text",
          "region": "text",
          "tags": [
            "tag1",
            "tag2"
          ]
        },
        "gcp": {
          "zone": "text",
          "credentials": {
            "type": "service_account",
            "project_id": "text",
            "private_key_id": "text",
            "private_key": "text",
            "client_email": "text",
            "client_id": "text",
            "auth_uri": "text",
            "token_uri": "text",
            "auth_provider_x509_cert_url": "text",
            "client_x509_cert_url": "text"
          },
          "labels": [
            "label1",
            "label2"
          ]
        },
        "s3": {
          "region": "us-east-1",
          "bucket": "text",
          "path": "text",
          "awsauthtype": "AccessKey",
          "accesskeyid": "text",
          "accesssecret": "text",
          "role": {
            "arn": "arn:aws:iam::464179634201:role/Extension"
          }
        },
        "sentinelone": {
          "base_url": "text",
          "params": {
            "accountId": "text",
            "filterId": "text"
          },
          "token": "text",
          "ranger": {
            "enabled": true
          }
        },
        "wiz": {
          "apiendpoint": "https://api.us1.app.wiz.io/graphql",
          "tokenurl": "https://auth.app.wiz.io/oauth/token",
          "clientid": "text",
          "clientsecret": "text"
        }
      }
    }
  ]
}

Create Context Integration

post

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

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

namestringRequired

The name of the context integration

typestring · enumRequired

The type of the context integration. The configuration parameters are dependent on this value.

Possible values:
enabledbooleanRequired

The state of the context integration. Whether to auto update or not.

updateintervalinteger · int32 · min: 3600 · max: 604800Required

The number of seconds by which to poll the integration.

Example: 86400
Responses
201

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

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

{
  "name": "text",
  "type": "aws",
  "enabled": true,
  "updateinterval": 86400,
  "aws": {
    "region": "us-east-1",
    "tags": [
      "tag1",
      "tag2"
    ],
    "awsauthtype": "AccessKey",
    "accesskeyid": "text",
    "accesssecret": "text",
    "role": {
      "arn": "arn:aws:iam::464179634201:role/Extension"
    }
  },
  "azure": {
    "clientid": "text",
    "clientsecret": "text",
    "subscriptionid": "text",
    "tenantid": "text",
    "tags": [
      "tag1",
      "tag2"
    ]
  },
  "crowdstrike": {
    "clientid": "text",
    "clientsecret": "text",
    "cloud": "us-1",
    "filter": "text",
    "sort": "text"
  },
  "crowdstrikediscover": {
    "clientid": "text",
    "clientsecret": "text",
    "cloud": "us-1",
    "filter": "text",
    "sort": "text"
  },
  "ibm": {
    "apikey": "text",
    "region": "text"
  },
  "oracle": {
    "user": "text",
    "tenancy": "text",
    "region": "text",
    "tags": [
      "tag1",
      "tag2"
    ]
  },
  "gcp": {
    "zone": "text",
    "credentials": {
      "type": "service_account",
      "project_id": "text",
      "private_key_id": "text",
      "private_key": "text",
      "client_email": "text",
      "client_id": "text",
      "auth_uri": "text",
      "token_uri": "text",
      "auth_provider_x509_cert_url": "text",
      "client_x509_cert_url": "text"
    },
    "labels": [
      "label1",
      "label2"
    ]
  },
  "s3": {
    "region": "us-east-1",
    "bucket": "text",
    "path": "text",
    "awsauthtype": "AccessKey",
    "accesskeyid": "text",
    "accesssecret": "text",
    "role": {
      "arn": "arn:aws:iam::464179634201:role/Extension"
    }
  },
  "sentinelone": {
    "base_url": "text",
    "params": {
      "accountId": "text",
      "filterId": "text"
    },
    "token": "text",
    "ranger": {
      "enabled": true
    }
  },
  "wiz": {
    "apiendpoint": "https://api.us1.app.wiz.io/graphql",
    "tokenurl": "https://auth.app.wiz.io/oauth/token",
    "clientid": "text",
    "clientsecret": "text"
  }
}
{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "id": "text",
      "created": "text",
      "lastupdated": "text",
      "allOf": {
        "name": "text",
        "type": "aws",
        "enabled": true,
        "updateinterval": 86400,
        "aws": {
          "region": "us-east-1",
          "tags": [
            "tag1",
            "tag2"
          ],
          "awsauthtype": "AccessKey",
          "accesskeyid": "text",
          "accesssecret": "text",
          "role": {
            "arn": "arn:aws:iam::464179634201:role/Extension"
          }
        },
        "azure": {
          "clientid": "text",
          "clientsecret": "text",
          "subscriptionid": "text",
          "tenantid": "text",
          "tags": [
            "tag1",
            "tag2"
          ]
        },
        "crowdstrike": {
          "clientid": "text",
          "clientsecret": "text",
          "cloud": "us-1",
          "filter": "text",
          "sort": "text"
        },
        "crowdstrikediscover": {
          "clientid": "text",
          "clientsecret": "text",
          "cloud": "us-1",
          "filter": "text",
          "sort": "text"
        },
        "ibm": {
          "apikey": "text",
          "region": "text"
        },
        "oracle": {
          "user": "text",
          "tenancy": "text",
          "region": "text",
          "tags": [
            "tag1",
            "tag2"
          ]
        },
        "gcp": {
          "zone": "text",
          "credentials": {
            "type": "service_account",
            "project_id": "text",
            "private_key_id": "text",
            "private_key": "text",
            "client_email": "text",
            "client_id": "text",
            "auth_uri": "text",
            "token_uri": "text",
            "auth_provider_x509_cert_url": "text",
            "client_x509_cert_url": "text"
          },
          "labels": [
            "label1",
            "label2"
          ]
        },
        "s3": {
          "region": "us-east-1",
          "bucket": "text",
          "path": "text",
          "awsauthtype": "AccessKey",
          "accesskeyid": "text",
          "accesssecret": "text",
          "role": {
            "arn": "arn:aws:iam::464179634201:role/Extension"
          }
        },
        "sentinelone": {
          "base_url": "text",
          "params": {
            "accountId": "text",
            "filterId": "text"
          },
          "token": "text",
          "ranger": {
            "enabled": true
          }
        },
        "wiz": {
          "apiendpoint": "https://api.us1.app.wiz.io/graphql",
          "tokenurl": "https://auth.app.wiz.io/oauth/token",
          "clientid": "text",
          "clientsecret": "text"
        }
      }
    }
  ]
}

Fetch Context Integration

get

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The ID of the context integration to be returned.

Responses
200

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

application/json
get/api/v1/integrations/context/{id}
GET /api/v1/integrations/context/{id} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "id": "text",
    "created": "text",
    "lastupdated": "text",
    "allOf": {
      "name": "text",
      "type": "aws",
      "enabled": true,
      "updateinterval": 86400,
      "aws": {
        "region": "us-east-1",
        "tags": [
          "tag1",
          "tag2"
        ],
        "awsauthtype": "AccessKey",
        "accesskeyid": "text",
        "accesssecret": "text",
        "role": {
          "arn": "arn:aws:iam::464179634201:role/Extension"
        }
      },
      "azure": {
        "clientid": "text",
        "clientsecret": "text",
        "subscriptionid": "text",
        "tenantid": "text",
        "tags": [
          "tag1",
          "tag2"
        ]
      },
      "crowdstrike": {
        "clientid": "text",
        "clientsecret": "text",
        "cloud": "us-1",
        "filter": "text",
        "sort": "text"
      },
      "crowdstrikediscover": {
        "clientid": "text",
        "clientsecret": "text",
        "cloud": "us-1",
        "filter": "text",
        "sort": "text"
      },
      "ibm": {
        "apikey": "text",
        "region": "text"
      },
      "oracle": {
        "user": "text",
        "tenancy": "text",
        "region": "text",
        "tags": [
          "tag1",
          "tag2"
        ]
      },
      "gcp": {
        "zone": "text",
        "credentials": {
          "type": "service_account",
          "project_id": "text",
          "private_key_id": "text",
          "private_key": "text",
          "client_email": "text",
          "client_id": "text",
          "auth_uri": "text",
          "token_uri": "text",
          "auth_provider_x509_cert_url": "text",
          "client_x509_cert_url": "text"
        },
        "labels": [
          "label1",
          "label2"
        ]
      },
      "s3": {
        "region": "us-east-1",
        "bucket": "text",
        "path": "text",
        "awsauthtype": "AccessKey",
        "accesskeyid": "text",
        "accesssecret": "text",
        "role": {
          "arn": "arn:aws:iam::464179634201:role/Extension"
        }
      },
      "sentinelone": {
        "base_url": "text",
        "params": {
          "accountId": "text",
          "filterId": "text"
        },
        "token": "text",
        "ranger": {
          "enabled": true
        }
      },
      "wiz": {
        "apiendpoint": "https://api.us1.app.wiz.io/graphql",
        "tokenurl": "https://auth.app.wiz.io/oauth/token",
        "clientid": "text",
        "clientsecret": "text"
      }
    }
  }
}

Update Context Integration

put

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The ID of the context integration to be updated

Body

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

namestringRequired

The name of the context integration

typestring · enumRequired

The type of the context integration. The configuration parameters are dependent on this value.

Possible values:
enabledbooleanRequired

The state of the context integration. Whether to auto update or not.

updateintervalinteger · int32 · min: 3600 · max: 604800Required

The number of seconds by which to poll the integration.

Example: 86400
Responses
200

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

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

{
  "name": "text",
  "type": "aws",
  "enabled": true,
  "updateinterval": 86400,
  "aws": {
    "region": "us-east-1",
    "tags": [
      "tag1",
      "tag2"
    ],
    "awsauthtype": "AccessKey",
    "accesskeyid": "text",
    "accesssecret": "text",
    "role": {
      "arn": "arn:aws:iam::464179634201:role/Extension"
    }
  },
  "azure": {
    "clientid": "text",
    "clientsecret": "text",
    "subscriptionid": "text",
    "tenantid": "text",
    "tags": [
      "tag1",
      "tag2"
    ]
  },
  "crowdstrike": {
    "clientid": "text",
    "clientsecret": "text",
    "cloud": "us-1",
    "filter": "text",
    "sort": "text"
  },
  "crowdstrikediscover": {
    "clientid": "text",
    "clientsecret": "text",
    "cloud": "us-1",
    "filter": "text",
    "sort": "text"
  },
  "ibm": {
    "apikey": "text",
    "region": "text"
  },
  "oracle": {
    "user": "text",
    "tenancy": "text",
    "region": "text",
    "tags": [
      "tag1",
      "tag2"
    ]
  },
  "gcp": {
    "zone": "text",
    "credentials": {
      "type": "service_account",
      "project_id": "text",
      "private_key_id": "text",
      "private_key": "text",
      "client_email": "text",
      "client_id": "text",
      "auth_uri": "text",
      "token_uri": "text",
      "auth_provider_x509_cert_url": "text",
      "client_x509_cert_url": "text"
    },
    "labels": [
      "label1",
      "label2"
    ]
  },
  "s3": {
    "region": "us-east-1",
    "bucket": "text",
    "path": "text",
    "awsauthtype": "AccessKey",
    "accesskeyid": "text",
    "accesssecret": "text",
    "role": {
      "arn": "arn:aws:iam::464179634201:role/Extension"
    }
  },
  "sentinelone": {
    "base_url": "text",
    "params": {
      "accountId": "text",
      "filterId": "text"
    },
    "token": "text",
    "ranger": {
      "enabled": true
    }
  },
  "wiz": {
    "apiendpoint": "https://api.us1.app.wiz.io/graphql",
    "tokenurl": "https://auth.app.wiz.io/oauth/token",
    "clientid": "text",
    "clientsecret": "text"
  }
}
{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "id": "text",
    "created": "text",
    "lastupdated": "text",
    "allOf": {
      "name": "text",
      "type": "aws",
      "enabled": true,
      "updateinterval": 86400,
      "aws": {
        "region": "us-east-1",
        "tags": [
          "tag1",
          "tag2"
        ],
        "awsauthtype": "AccessKey",
        "accesskeyid": "text",
        "accesssecret": "text",
        "role": {
          "arn": "arn:aws:iam::464179634201:role/Extension"
        }
      },
      "azure": {
        "clientid": "text",
        "clientsecret": "text",
        "subscriptionid": "text",
        "tenantid": "text",
        "tags": [
          "tag1",
          "tag2"
        ]
      },
      "crowdstrike": {
        "clientid": "text",
        "clientsecret": "text",
        "cloud": "us-1",
        "filter": "text",
        "sort": "text"
      },
      "crowdstrikediscover": {
        "clientid": "text",
        "clientsecret": "text",
        "cloud": "us-1",
        "filter": "text",
        "sort": "text"
      },
      "ibm": {
        "apikey": "text",
        "region": "text"
      },
      "oracle": {
        "user": "text",
        "tenancy": "text",
        "region": "text",
        "tags": [
          "tag1",
          "tag2"
        ]
      },
      "gcp": {
        "zone": "text",
        "credentials": {
          "type": "service_account",
          "project_id": "text",
          "private_key_id": "text",
          "private_key": "text",
          "client_email": "text",
          "client_id": "text",
          "auth_uri": "text",
          "token_uri": "text",
          "auth_provider_x509_cert_url": "text",
          "client_x509_cert_url": "text"
        },
        "labels": [
          "label1",
          "label2"
        ]
      },
      "s3": {
        "region": "us-east-1",
        "bucket": "text",
        "path": "text",
        "awsauthtype": "AccessKey",
        "accesskeyid": "text",
        "accesssecret": "text",
        "role": {
          "arn": "arn:aws:iam::464179634201:role/Extension"
        }
      },
      "sentinelone": {
        "base_url": "text",
        "params": {
          "accountId": "text",
          "filterId": "text"
        },
        "token": "text",
        "ranger": {
          "enabled": true
        }
      },
      "wiz": {
        "apiendpoint": "https://api.us1.app.wiz.io/graphql",
        "tokenurl": "https://auth.app.wiz.io/oauth/token",
        "clientid": "text",
        "clientsecret": "text"
      }
    }
  }
}

Delete Context Integration

delete

Deletes a context integration

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The ID of the context integration to be deleted

Responses
204

An empty array

No content

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

No content

Dry Run/Test a Context Integration

get

Runs the specified context integration. Retuns a list of ip labels that would be imported when the context integration is run.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

The ID of the context integration to be test run.

Responses
200

List of IP Labels Requested

application/json
get/api/v1/integrations/context/{id}/run
GET /api/v1/integrations/context/{id}/run HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "ip": "10.250.0.1",
      "context": "name",
      "labels": [
        "name1",
        "name2"
      ]
    }
  ]
}

Run a Context Integration

put

Runs the specified context integration. Returns a list of ip labels that were imported.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

The ID of the context integration to be test run.

Responses
200

List of IP Labels Requested

application/json
put/api/v1/integrations/context/{id}/run
PUT /api/v1/integrations/context/{id}/run HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "ip": "10.250.0.1",
      "context": "name",
      "labels": [
        "name1",
        "name2"
      ]
    }
  ]
}

Regenerate private/public keys.

put

Only applicable to Oracle Cloud.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

String ID of the role to get

Responses
200

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

application/json
put/api/v1/integrations/context/{id}/regenkeys
PUT /api/v1/integrations/context/{id}/regenkeys HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": {
    "id": "text",
    "created": "text",
    "lastupdated": "text",
    "allOf": {
      "name": "text",
      "type": "aws",
      "enabled": true,
      "updateinterval": 86400,
      "aws": {
        "region": "us-east-1",
        "tags": [
          "tag1",
          "tag2"
        ],
        "awsauthtype": "AccessKey",
        "accesskeyid": "text",
        "accesssecret": "text",
        "role": {
          "arn": "arn:aws:iam::464179634201:role/Extension"
        }
      },
      "azure": {
        "clientid": "text",
        "clientsecret": "text",
        "subscriptionid": "text",
        "tenantid": "text",
        "tags": [
          "tag1",
          "tag2"
        ]
      },
      "crowdstrike": {
        "clientid": "text",
        "clientsecret": "text",
        "cloud": "us-1",
        "filter": "text",
        "sort": "text"
      },
      "crowdstrikediscover": {
        "clientid": "text",
        "clientsecret": "text",
        "cloud": "us-1",
        "filter": "text",
        "sort": "text"
      },
      "ibm": {
        "apikey": "text",
        "region": "text"
      },
      "oracle": {
        "user": "text",
        "tenancy": "text",
        "region": "text",
        "tags": [
          "tag1",
          "tag2"
        ]
      },
      "gcp": {
        "zone": "text",
        "credentials": {
          "type": "service_account",
          "project_id": "text",
          "private_key_id": "text",
          "private_key": "text",
          "client_email": "text",
          "client_id": "text",
          "auth_uri": "text",
          "token_uri": "text",
          "auth_provider_x509_cert_url": "text",
          "client_x509_cert_url": "text"
        },
        "labels": [
          "label1",
          "label2"
        ]
      },
      "s3": {
        "region": "us-east-1",
        "bucket": "text",
        "path": "text",
        "awsauthtype": "AccessKey",
        "accesskeyid": "text",
        "accesssecret": "text",
        "role": {
          "arn": "arn:aws:iam::464179634201:role/Extension"
        }
      },
      "sentinelone": {
        "base_url": "text",
        "params": {
          "accountId": "text",
          "filterId": "text"
        },
        "token": "text",
        "ranger": {
          "enabled": true
        }
      },
      "wiz": {
        "apiendpoint": "https://api.us1.app.wiz.io/graphql",
        "tokenurl": "https://auth.app.wiz.io/oauth/token",
        "clientid": "text",
        "clientsecret": "text"
      }
    }
  }
}

Last updated