Log-Format-Profile - Flexible Secure Gateway API References (1.13.0)
Download OpenAPI specification:Download
Log-Format-Profiles is the object for log format rules. Log-Format-Profiles will be applied to all Cells that belong to specified Cell-Groups.
Get Log-Format-Profiles
Get Log-Format-Profile resources.
Authorizations:
query Parameters
| id | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the resource. |
| name | string ^[a-zA-Z]{1}[a-zA-Z0-9-\_\.]{0,30}$ A name of the resource. |
| cellGroupId | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The Cell-Group ID which the resource belongs. |
| _limit | integer >= 1 The maximum number of items to return. |
| _offset | integer >= 0 The number of items to skip before starting to return results. |
| _order_by | Array of strings Items Enum: "id" "name" "cellGroupId" "tenantId" "createdAt" "updatedAt" Sort keys. |
header Parameters
| X-Auth-Token required | string The keystone token. |
Responses
200
OK
400
Bad Request
401
Unauthorized
500
Internal Server Error
get/v1/log-format-profiles
https://api.ntt.com/dsigw-erg/v1/log-format-profiles
Response samples
- 200
- 400
- 401
- 500
Content type
application/json
Copy
Expand all Collapse all {- "logFormatProfiles": [
- {
- "id": "5be775de-aa0b-468c-ba69-6e35dc5c5c32",
- "name": "CEF_log_format_profile",
- "logFormat": "CEF...",
- "cellGroupId": "86acc283-c60d-4c3f-a193-77e249a9c3ab",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "createdAt": "2019-05-14T03:04:48Z",
- "updatedAt": "2019-05-14T03:04:48Z"
}
]
}Create Log-Format-Profile
Create a Log-Format-Profile resource.
Authorizations:
header Parameters
| X-Auth-Token required | string The keystone token. |
Request Body schema: application/json
| logFormatProfile required | object (logFormatProfileCreateRequest) A Log-Format-Profile Object. |
Responses
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
500
Internal Server Error
post/v1/log-format-profiles
https://api.ntt.com/dsigw-erg/v1/log-format-profiles
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "logFormatProfile": {
- "name": "test_log_format_profile",
- "logFormat": "CEF...",
- "cellGroupId": "86acc283-c60d-4c3f-a193-77e249a9c3ab"
}
}Response samples
- 200
- 400
- 401
- 403
- 500
Content type
application/json
Copy
Expand all Collapse all {- "logFormatProfile": {
- "id": "5be775de-aa0b-468c-ba69-6e35dc5c5c32",
- "name": "test_log_format_profile",
- "logFormat": "CEF...",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "cellGroupId": "86acc283-c60d-4c3f-a193-77e249a9c3ab",
- "operationId": "715ee526-1c17-44c4-822d-c3c044babfe8",
- "createdAt": "2019-05-14T03:04:48Z",
- "updatedAt": "2019-05-14T03:04:48Z"
}
}Get Log-Format-Profile Details
Get a Log-Format-Profile resource.
Authorizations:
path Parameters
| log_format_profile_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the resource. |
header Parameters
| X-Auth-Token required | string The keystone token. |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
get/v1/log-format-profiles/{log_format_profile_id}
https://api.ntt.com/dsigw-erg/v1/log-format-profiles/{log_format_profile_id}
Response samples
- 200
- 400
- 401
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "logFormatProfile": {
- "id": "5be775de-aa0b-468c-ba69-6e35dc5c5c32",
- "name": "test_log_format_profile",
- "logFormat": "CEF...",
- "cellGroupId": "86acc283-c60d-4c3f-a193-77e249a9c3ab",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "createdAt": "2019-05-14T03:04:48Z",
- "updatedAt": "2019-05-14T03:04:48Z"
}
}Update Log-Format-Profile
Update a Log-Format-Profile resource.
Authorizations:
path Parameters
| log_format_profile_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the resource. |
header Parameters
| X-Auth-Token required | string The keystone token. |
Request Body schema: application/json
| logFormatProfile required | object (logFormatProfileUpdateRequest) A Log-Format-Profile Object. |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
patch/v1/log-format-profiles/{log_format_profile_id}
https://api.ntt.com/dsigw-erg/v1/log-format-profiles/{log_format_profile_id}
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "logFormatProfile": {
- "name": "test_log_format_profile_updated",
- "logFormat": "CEF..."
}
}Response samples
- 200
- 400
- 401
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "logFormatProfile": {
- "id": "5be775de-aa0b-468c-ba69-6e35dc5c5c32",
- "name": "test_log_format_profile_updated",
- "logFormat": "CEF...",
- "cellGroupId": "86acc283-c60d-4c3f-a193-77e249a9c3ab",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "operationId": "715ee526-1c17-44c4-822d-c3c044babfe8",
- "createdAt": "2019-05-14T03:04:48Z",
- "updatedAt": "2019-05-14T03:04:48Z"
}
}Delete Log-Format-Profile
Delete a Log-Format-Profile resource.
Authorizations:
path Parameters
| log_format_profile_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the resource. |
header Parameters
| X-Auth-Token required | string The keystone token. |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
delete/v1/log-format-profiles/{log_format_profile_id}
https://api.ntt.com/dsigw-erg/v1/log-format-profiles/{log_format_profile_id}
Response samples
- 400
- 401
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "errorCode": 400,
- "errorMessage": "Invalid request",
- "moreInfo": "{{moreInfo}}"
}