Page tree

Contents

BloxOne Admin API consists of:

●  Sharing Info APIs (sharing): Provide information about organizations and groups which provide thereat indicators or can be shared with.

●  Resource Info APIs (resources): Manage data profiles. GET requests retrieve information, POST create a profile. API FAQ contains information on how to create a profile.

●  Governance Policy APIs (governance): Manage governance policies. GET requests retrieve information, POST create a policy. API FAQ contains information on how to create a policy.


CURL Command Requests
RequestDescription
curl “https://platform.activetrust.net:8000/api/data/threats/host?profile=IID&dga=false&from_date=2017-06-04T00:00:00Z&data_format=csv&rlimit=100” -u [YOUR_API_KEY]:1000 threat indicators in CSV format which were added after 2017-06-04 GMT (Date/Time is in ISO 8601 format) by Infoblox and are not DGA.
curl “https://platform.activetrust.net:8000/api/data/threats/state/host?Profile=IID&data_format=json” -u [YOUR_API_KEY]:All currently active hostname threats detected by Infoblox (IID).
curl “https://platform.activetrust.net:8000/api/data/threats?type=host&profile=IID& period=30min&data_format=json” -u [YOUR_API_KEY]:Infoblox-sourced hostnames for the past 30 minutes.
curl “https://platform.activetrust.net:8000/api/data/threats?profile=AIS-FEDGOV,iSIGHTPARTNERS& period=1w&data_format=csv ” -u [YOUR_API_KEY]:iSight Partners and DHS AIS IPs for the past week, in CSV format.


Sharing Info APIs

The Sharing Info APIs indicate which organizations are sharing data with you or what organizations are available for data exchange.

Object

The following object may be returned by the Sharing Info APIs:

Response Info

Field

Type

Description

code

integer

Response code (0 - success)

status

string

Response status

data

array[string], optional

Organization IDs

APIs

API

Method

Description

/admin/sharing/source_orgs

GET

Gets sharing organizations

/admin/sharing/target_orgs

GET

Gets organizations available for sharing

Get Sharing Organizations

Gets a list of organization IDs sharing data with your organization. These organization IDs can be used in threat data searches (in the “profile” query string parameters) to get data shared only by those specific organization.

Request
Request Endpoint

GET /admin/sharing/source_orgs

Request Body

N/A

Path Parameters

N/A

Query Parameters

N/A

Response

If the submission is successful, the HTTP code 200 (OK) will be returned, along with a list of organizations sharing data with the API caller’s organization.

If an error occurs, the following code may be returned:

HTTP Status Code

Reason

400

Invalid request

401

Unauthorized, user has not submitted valid credentials

Example

Request:

curl -u [YOUR_API_KEY]: https://api.activetrust.net:8000/api/admin/sharing/source_orgs  

Response:

{
    "code": 0,
    "data": [
        "OrgA",
        "OrgB",
        "DemoOrg",
        "IID"
    ],
    "status": "success"
}

Get Organizations Available for Sharing

Gets a list of organization IDs that can be used for sharing. These organization IDs can be used in the “org” field of the governance policy rules when you create new governance policies or modify existing governance policies.

Request
Request Endpoint

GET /admin/sharing/target_orgs

Request Body

N/A

Path Parameters

N/A

Query Parameters

N/A

Response

If the submission is successful, the HTTP code 200 (OK) will be returned, along with a list of organizations available for sharing.

If an error occurs, the following code may be returned:

HTTP Status Code

Reason

400

Invalid request

401

Unauthorized, user has not submitted valid credentials

Example

Request:

curl -u [YOUR_API_KEY]: https://api.activetrust.net:8000/api/admin/sharing/target_orgs
Response:

{
    "code": 0,
    "data": [
        "OrgA",
        "IID",
        "OrgB"
    ],
    "status": "success"
}

Resource Info APIs

Resource info APIs create and retrieve data profiles for the user’s organization.

Objects

The following objects may be returned by the Resource Info APIs:

NewDataProfileResults

Field

Type

Description

status

string, optional

Data profile creation status

DataProfile

Field

Type

Description

id

string

Data profile ID: 'org_id: data_profile_name'

name

string

Data profile name. Must be unique within the target org. Immutable once set

displayName

string

Data profile display name

description

string, optional

Data profile description

policy

string

The name of the governance policy associated with the data profile

APIs

API

Method

Description

/admin/resources/dataprofiles

POST

Creates a new data profile

/admin/resources/dataprofiles

GET

Gets data profiles

/admin/resources/dataprofiles/{profile_name}

GET

Gets a data profile by name

Create New Data Profile

Creates a new data profile for the user’s organization.

Request
Request Endpoint

POST /admin/resources/dataprofiles

Request Body

Data profile form

Form Parameters

Parameter

Value

Data Type

Description

name

required

string

Data profile name. Must be unique within the target org. Immutable once set.

display_name

required

string

Data profile display name

description

 

string

Optional data profile description

policy

 

string

The name of the governance policy associated with the data profile. The specified policy must exist or the call will fail.

Path Parameters

N/A

Query Parameters

N/A

Response

If the submission is successful, the HTTP code 201 (Created) will be returned, along with the created data profile object.

If an error occurs, one of the following codes may be returned:

HTTP Status Code

Reason

400

Call error. The reason is provided in the “error” response field. For example, if the “policy” data profile field is set to unknown value then the “error” message will be “Policy is not found”.

401

Unauthorized, user has not submitted valid credentials

Example

Request:

curl -X POST -H "Content-Type:application/json" -u [YOUR_API_KEY]: https://api.activetrust.net:8000/api/admin/resources/dataprofiles -d '{"name": "my_data_profile_one","description":"My Data Profile","policy":"data_policy_one"}'

Response:

  {
    "code": 0,
    "data": {
        "description": "My Data Profile",
        "displayName": "my_data_profile_one",
        "id": "OrgA:my_data_profile_one",
        "name": "my_data_profile_one",
        "policy": "data_policy_one"
    },
    "status": "success"
}

Get Data Profiles

Gets a list of data profiles for the user’s organization.

Request
Request Endpoint

GET /admin/resources/dataprofiles

Request Body

N/A

Path Parameters

N/A

Query Parameters

N/A

Response

If the submission is successful, the HTTP code 200 (OK) will be returned, along with a list of data profile objects.

If an error occurs, the following code may be returned:

HTTP Status Code

Reason

400

Invalid request

401

Unauthorized, user has not submitted valid credentials

Example

Request:

curl -u [YOUR_API_KEY]: https://api.activetrust.net:8000/api/admin/resources/dataprofiles

Response:

{
    "code": 0,
    "data": [
        {
            "displayName": "new_dp_one",
            "id": "OrgA:new_dp_one",
            "name": "new_dp_one",
            "policy": "data_policy_one"
        },
        {
            "displayName": "new_test_profile_one",
            "id": "OrgA:new_test_profile_one",
            "name": "new_test_profile_one",
            "policy": "new_test_policy_one"
        },
        {
            "displayName": "new_dp_two",
            "id": "OrgA:new_dp_two",
            "name": "new_dp_two",
            "policy": "data_policy_one"
        }
    ],
    "status": "success"
}

Get Data Profile

Gets a data profile object by name for the user’s organization.

Request
Request Endpoint

GET /admin/resources/dataprofiles/{profile_name}

Request Body

N/A

Path Parameters

Parameter

Value

Data Type

Description

profile_name

required

string

Data profile name

Query Parameters

N/A

Response

If the submission is successful, the HTTP code 200 (OK) will be returned, along with a data profile object.

If an error occurs, one of the following codes may be returned:

HTTP Status Code

Reason

400

Invalid request

401

Unauthorized, user has not submitted valid credentials

404

Data profile not found

Example

Request:

curl -u [YOUR_API_KEY]: https://api.activetrust.net:8000/api/admin/resources/dataprofiles/new_dp_one

Response:

{
    "code": 0,
    "data": {
        "displayName": "new_dp_one",
        "id": "OrgA:new_dp_one",
        "name": "new_dp_one",
        "policy": "data_policy_one"
    },
    "status": "success"
}


Governance Policy APIs

These APIs create new governance policies objects for later retrieval within an organization.

Objects

The following objects are used by the Governance APIs:

Policy

Field

Type

Description

name

string

Policy name

description

string, optional

Policy description

rules

array[Rule], optional

Policy rules

Rule

Field

Type

Description

org

string

Organization name

action

string = ['allow']

Sharing action

options

SharingOptions

Sharing options applied to the selected organization

SharingOptions

Field

Type

Description

attribution

boolean

Share attribution?

class

boolean

Share threat class?

property

boolean

Share property?

targets

boolean

Share targets?

 

APIs

NameMethodDescription
/admin/governance/policiesPOSTCreates a new policy
/admin/governance/policiesGETGets governance policies
/admin/governance/policies/{policy_name}GETGets a policy by name


Create a New Policy

Creates a new governance policy for the user’s organization.

Request
Request Endpoint

POST /admin/governance/policies

Request Body

The request body will contain the data for the new governance policy as shown under Objects.

Path Parameters

N/A

Query Parameters

N/A

Response

If the submission is successful, the HTTP code 201 (Created) will be returned, along with a new Governance Policy object (excluding the policy rules).

If an error occurs, one of the following codes may be returned:

HTTP Status Code

Reason

400

Invalid request

401

Unauthorized, user has not submitted valid credentials

Example

Request:

curl -X POST -H "Content-Type:application/json" -u [YOUR_API_KEY]: https://api.activetrust.net:8000/api/admin/governance/policies -d '{"name":"my_policy","rules":[{"org": "OrgB","action": "allow","options":{"attribution":true,"class":true,"property":true,"targets": true}}]}'

Response:

  {
    "code": 0,
    "data": {
        "name": "my_policy",
        "org": "OrgA"
    },
    "status": "success"
}

Get Policies

Gets a list of governance policy objects for the user’s organization.

Request
Request Endpoint

GET /admin/governance/policies

Request Body

N/A

Path Parameters

N/A

Query Parameters

N/A

Response

If the submission is successful, the HTTP code 200 (OK) will be returned, along with a list of policy objects.

If an error occurs, one of the following codes may be returned:

 HTTP Status Code

Reason

400

Invalid request

401

Unauthorized, user has not submitted valid credentials

Example

Request:

curl -u [YOUR_API_KEY]: https://api.activetrust.net:8000/api/admin/governance/policies

Response:

  {
    "code": 0,
    "data": [
        {
            "description": "Data policy one description",
            "name": "data_policy_one",
            "org": "OrgA",
            "rules": [
                {
                    "action": "allow",
                    "options": {
                        "attribution": true,
                        "class": true,
                        "property": true,
                        "targets": true
                    },
                    "org": "OrgA"
                },
                {
                    "action": "allow",
                    "options": {
                        "attribution": true,
                        "class": true,
                        "property": true,
                        "targets": true
                    },
                    "org": "IID"
                },
                {
                    "action": "allow",
                    "options": {
                        "attribution": false,
                        "class": false,
                        "property": false,
                        "targets": false
                    },
                    "org": "OrgB"
                }
            ]
        }
    ],
    "status": "success"
}

Get a Policy

Gets a governance policy object by name for the user’s organization.

Request
Request Endpoint

GET /admin/governance/policies/{policy_name}

Request Body

N/A

Path Parameters

Parameter

Data Type

Description

policy_name

string

Policy name

Query Parameters

N/A

Response

If the submission is successful, the HTTP code 200 (OK) will be returned, along with the governance policy object.

If an error occurs, one of the following codes may be returned:

HTTP Status Code

Reason

400

Invalid request

401

Unauthorized, user has not submitted valid credentials

Example

Request:

curl -u [YOUR_API_KEY]: https://api.activetrust.net:8000/api/admin/governance/policies/data_policy_one

Response:

  {
    "code": 0,
    "data": {
        "description": "Data policy one description",
        "name": "data_policy_one",
        "org": "OrgA",
        "rules": [
            {
                "action": "allow",
                "options": {
                    "attribution": true,
                    "class": true,
                    "property": true,
                    "targets": true
                },
                "org": "OrgA"
            },
            {
                "action": "allow",
                "options": {
                    "attribution": true,
                    "class": true,
                    "property": true,
                    "targets": true
                },
                "org": "IID"
            },
            {
                "action": "allow",
                "options": {
                    "attribution": false,
                    "class": false,
                    "property": false,
                    "targets": false
                },
                "org": "OrgB"
            }
        ]
    },
    "status": "success"
}


  • No labels

This page has no comments.