logconf

Download Spec

get /role-store/api/v1/logconf/collectors

Get logconf collectors.

Authorization

string

required

OAuth2 token

Default
"Bearer a-proper-token-goes-here"

Response

ExamplesSchema

Successful response, returns logconf collectors.

{
  "count": 123,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "name": "string",
      "type": "AWS",
      "enabled": true,
      "updated": "2023-06-07T17:32:28Z",
      "status_code;": "OK",
      "status_text": "string",
      "aws_log_region": "string",
      "iam_access_key_id": "string",
      "iam_secret_access_key": "string",
      "iam_session_token": "string",
      "azure_event_hubs_namespace": "string",
      "azure_resource_group_name": "string",
      "azure_subscription_id": "string",
      "azure_event_hub_name": "string",
      "azure_tenant_id": "string",
      "azure_client_id": "string",
      "azure_client_secret": "string",
      "azure_sas_connection_string": "string"
    }
  ]
}

post /role-store/api/v1/logconf/collectors

Create logconf collector.

id

string

uuid

name

string

type

string

Enum
  • AWS
  • AZURE
  • GOOGLE

enabled

boolean

updated

string

date-time

status_code;

string

Enum
  • OK
  • NOK
  • DISABLED

status_text

string

aws_log_region

string

iam_access_key_id

string

iam_secret_access_key

string

iam_session_token

string

azure_event_hubs_namespace

string

azure_resource_group_name

string

azure_subscription_id

string

azure_event_hub_name

string

azure_tenant_id

string

azure_client_id

string

azure_client_secret

string

azure_sas_connection_string

string

Request

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "name": "string",
  "type": "AWS",
  "enabled": true,
  "updated": "2023-06-07T17:32:28Z",
  "status_code;": "OK",
  "status_text": "string",
  "aws_log_region": "string",
  "iam_access_key_id": "string",
  "iam_secret_access_key": "string",
  "iam_session_token": "string",
  "azure_event_hubs_namespace": "string",
  "azure_resource_group_name": "string",
  "azure_subscription_id": "string",
  "azure_event_hub_name": "string",
  "azure_tenant_id": "string",
  "azure_client_id": "string",
  "azure_client_secret": "string",
  "azure_sas_connection_string": "string"
}

Response

ExamplesSchema

Successful response, logconf collector created.

{
  "id": "string"
}

get /role-store/api/v1/logconf/collectors/{collector_id}

Get logconf collector.

collector_id

string

required

Response

ExamplesSchema

Successful response, returns found logconf collector.

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "name": "string",
  "type": "AWS",
  "enabled": true,
  "updated": "2023-06-07T17:32:28Z",
  "status_code;": "OK",
  "status_text": "string",
  "aws_log_region": "string",
  "iam_access_key_id": "string",
  "iam_secret_access_key": "string",
  "iam_session_token": "string",
  "azure_event_hubs_namespace": "string",
  "azure_resource_group_name": "string",
  "azure_subscription_id": "string",
  "azure_event_hub_name": "string",
  "azure_tenant_id": "string",
  "azure_client_id": "string",
  "azure_client_secret": "string",
  "azure_sas_connection_string": "string"
}

put /role-store/api/v1/logconf/collectors/{collector_id}

Update logconf collector.

id

string

uuid

name

string

type

string

Enum
  • AWS
  • AZURE
  • GOOGLE

enabled

boolean

updated

string

date-time

status_code;

string

Enum
  • OK
  • NOK
  • DISABLED

status_text

string

aws_log_region

string

iam_access_key_id

string

iam_secret_access_key

string

iam_session_token

string

azure_event_hubs_namespace

string

azure_resource_group_name

string

azure_subscription_id

string

azure_event_hub_name

string

azure_tenant_id

string

azure_client_id

string

azure_client_secret

string

azure_sas_connection_string

string

Request

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "name": "string",
  "type": "AWS",
  "enabled": true,
  "updated": "2023-06-07T17:32:28Z",
  "status_code;": "OK",
  "status_text": "string",
  "aws_log_region": "string",
  "iam_access_key_id": "string",
  "iam_secret_access_key": "string",
  "iam_session_token": "string",
  "azure_event_hubs_namespace": "string",
  "azure_resource_group_name": "string",
  "azure_subscription_id": "string",
  "azure_event_hub_name": "string",
  "azure_tenant_id": "string",
  "azure_client_id": "string",
  "azure_client_secret": "string",
  "azure_sas_connection_string": "string"
}

Response

ExamplesSchema

Successful response, logconf collector updated.

{
  "id": "string"
}

delete /role-store/api/v1/logconf/collectors/{collector_id}

Delete logconf collector.

collector_id

string

required

Response

ExamplesSchema

Successfully removed logconf collector.

Empty response

Was this page helpful?