openapi: 3.2.0 info: title: Fenergo Nebula LoggingCentre Logs API description: '**LoggingCentre API**: LoggingCentre API provides endpoints in order to manage, retrieve and configure all related models and their versions. **LoggingCentre API provides**:' version: '1.0' servers: - url: /logging-centre security: - Bearer: [] tags: - name: Logs paths: /api/logs/getqueryids: post: tags: - Logs summary: This endpoint is used to get the query id for the log entries based on the… description: 'Required permissions: Following permissions are required: LoggingCentreAccess' parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: The query parameters content: application/json: schema: allOf: - $ref: '#/components/schemas/LogEntryQueryDtoServiceRequest' responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/LogEntryQueryIdDtoServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT operationId: postApiLogsGetqueryids x-operation-id-source: derived /api/logs/correlationid/{correlationId}: get: tags: - Logs summary: This endpoint is used to get the query id for the log entries based on the… description: 'Required permissions: Following permissions are required: LoggingCentreAccess' operationId: ByCorrelationId parameters: - name: correlationId in: path description: The correlation id for which logs should be included required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/LogEntryQueryIdDtoServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/logs/entityid/{entityId}: get: tags: - Logs summary: This endpoint is used to get the query id for the log entries based on the… description: 'Required permissions: Following permissions are required: LoggingCentreAccess' operationId: ByEntityId parameters: - name: entityId in: path description: Entity Id for which logs should be included required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/LogEntryQueryIdDtoServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/logs/journeyid/{journeyId}: get: tags: - Logs summary: This endpoint is used to get the query id for the log entries based on the… description: 'Required permissions: Following permissions are required: LoggingCentreAccess' operationId: ByJourneyId parameters: - name: journeyId in: path description: Journey Id for which logs should be included required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/LogEntryQueryIdDtoServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/logs/component/{componentType}/{instanceId}: get: tags: - Logs summary: This endpoint is used to get the query id for the log entries based on the… description: 'Required permissions: Following permissions are required: LoggingCentreAccess' operationId: ByComponentTypeAndInstanceId parameters: - name: componentType in: path description: Compontent type for which logs should be included required: true schema: type: string - name: instanceId in: path description: Instance Id for which logs should be included required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/LogEntryQueryIdDtoServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/logs/{queryId}: get: tags: - Logs summary: This endpoint is used to get the log entries by the query id description: 'Required permissions: Following permissions are required: LoggingCentreAccess' operationId: GetLogsByQueryId parameters: - name: queryId in: path description: The query id generated from another endpoints required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/LogsQueryResultsDtoServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/logs: get: tags: - Logs summary: This endpoint allows to get logging status for specific tenant description: 'Required permissions: Following permissions are required: LoggingCentreAccess' operationId: GetLoggingStatus parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/LoggingStatusQueryResultDtoServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/logs/optin: post: tags: - Logs summary: This endpoint allows to opt in to logging centre. description: 'Required permissions: Following permissions are required: LoggingCentreEdit' operationId: OptIn parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/OptInRequestDto' description: Represents a request to opt in. responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/OptInResultDtoServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/logs/optout: post: tags: - Logs summary: This endpoint allows to opt out from logging centre. description: 'Required permissions: Following permissions are required: LoggingCentreEdit' operationId: OptOut parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/OptInResultDtoServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT components: schemas: LogsQueryResultsDto: type: object properties: values: type: - array - 'null' items: $ref: '#/components/schemas/LogsQueryResultDto' description: Log entries status: allOf: - $ref: '#/components/schemas/LogStatus' description: Status of query additionalProperties: false description: The results of a query to retrieve log entries from CloudWatch. LogsQueryResultsDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/LogsQueryResultsDto' description: The results of a query to retrieve log entries from CloudWatch. messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false OptInResultDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/OptInResultDto' description: The results of a query to retrieve log entries from CloudWatch. messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false OptInResultDto: type: object properties: success: type: boolean description: '' message: type: - string - 'null' description: '' additionalProperties: false description: The results of a query to retrieve log entries from CloudWatch. LoggingStatusQueryResultDto: type: object properties: optInStatus: type: - boolean - 'null' message: type: - string - 'null' domains: type: - array - 'null' items: type: string additionalProperties: false LogEntryQueryIdDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/LogEntryQueryIdDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false OptInRequestDto: type: object properties: domains: type: - array - 'null' items: type: string additionalProperties: false description: Represents a request to opt in. RequestMetadata: type: object properties: tenant: type: - string - 'null' userId: type: - string - 'null' clientId: type: - string - 'null' causationId: type: - string - 'null' correlationId: type: - string - 'null' customSystemLabel: type: - string - 'null' additionalProperties: false LogEntryQueryIdDto: type: object properties: queryId: type: - string - 'null' metadata: allOf: - $ref: '#/components/schemas/RequestMetadata' additionalProperties: false ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false LogsQueryResultDto: type: object properties: timestamp: type: - string - 'null' message: type: - string - 'null' correlationId: type: - string - 'null' componentType: type: - string - 'null' instanceId: type: - string - 'null' integrationName: type: - string - 'null' source: type: - string - 'null' severity: type: - string - 'null' errorCode: type: - string - 'null' description: type: - string - 'null' additionalInformation: type: - string - 'null' entityId: type: - string - 'null' journeyId: type: - string - 'null' properties: type: - object - 'null' additionalProperties: type: string additionalProperties: false LogEntryQueryDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/LogEntryQueryDto' description: Represents a query to search for log entries in the logging centre. additionalProperties: false ProblemDetails: type: object properties: type: type: - string - 'null' title: type: - string - 'null' status: type: - integer - 'null' format: int32 detail: type: - string - 'null' instance: type: - string - 'null' additionalProperties: {} ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StringServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false LogStatus: enum: - InProgress - Completed type: string LoggingStatusQueryResultDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/LoggingStatusQueryResultDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false LogEntryQueryDto: type: object properties: startDate: type: - string - 'null' format: date-time endDate: type: - string - 'null' format: date-time correlationId: type: - string - 'null' componentType: type: - string - 'null' instanceId: type: - string - 'null' integrationName: type: - string - 'null' source: type: - string - 'null' severity: type: - string - 'null' errorCode: type: - string - 'null' description: type: - string - 'null' additionalInformation: type: - string - 'null' entityId: type: - string - 'null' journeyId: type: - string - 'null' additionalProperties: false description: Represents a query to search for log entries in the logging centre. securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header