Jump to

• Request
• Response

Get a deployment debug log

get

https://{your_site_interface}/opa-hub/api/12.2.36/deployments/{deployment-name}/debugLogs/{deployment-debug-log-uid}

This operation will get a deployment debug log.

Request

Path Parameters

• deployment-debug-log-uid(required): string
  The unique identifier generated by the system for the debug log.
• deployment-name(required): string
  The name of the deployment.

Query Parameters

• expand: string
  Comma separated list of named resources to expand, or "all" to expand all
• fields: string
  Comma separated list of fields to be returned
• links: string
  Comma separated list of links to be returned, or "none" to omit links

There's no request body for this operation.

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The request was successfully completed.

Body ()

Root Schema : deploymentDebugLog

Type: object

Show Source

• content: object deploymentDebugLogContent
• date: string (date-time)
  Read Only: true

  The date the debug log was created.
• deploymentVersion: number (double)
  Read Only: true

  The deployment version that initiated the debug log.
• events: object deploymentDebugEvents
• function: string
  Read Only: true

  The name of the function that initiated the debug log.
• outcome: string
  Read Only: true

  The outcome of the debug log.
• product: string
  Read Only: true

  The name of the product that initiated the debug log.
• uid: string
  Read Only: true

  The unique identifier generated by the system for the debug log.

{
    "type":"object",
    "properties":{
        "uid":{
            "type":"string",
            "description":"The unique identifier generated by the system for the debug log.",
            "readOnly":true
        },
        "outcome":{
            "type":"string",
            "description":"The outcome of the debug log.",
            "readOnly":true
        },
        "date":{
            "type":"string",
            "format":"date-time",
            "description":"The date the debug log was created.",
            "readOnly":true
        },
        "product":{
            "type":"string",
            "description":"The name of the product that initiated the debug log.",
            "readOnly":true
        },
        "function":{
            "type":"string",
            "description":"The name of the function that initiated the debug log.",
            "readOnly":true
        },
        "deploymentVersion":{
            "type":"number",
            "format":"double",
            "description":"The deployment version that initiated the debug log.",
            "readOnly":true
        },
        "events":{
            "readOnly":true,
            "$ref":"#/components/schemas/deploymentDebugEvents"
        },
        "content":{
            "readOnly":true,
            "$ref":"#/components/schemas/deploymentDebugLogContent"
        }
    },
    "additionalProperties":false
}

Nested Schema : deploymentDebugLogContent

Type: object

Show Source

• base64: string (byte)
  Read Only: true

  The binary content of the debug log as a base-64 encoded string.

  Example: QmFzZS02NCBkYXRhLg==
• fileName: string
  Read Only: true

  The name of the debug log data file.
• mimeType: string
  Read Only: true

  The MIME type of the debug log data file.

{
    "type":"object",
    "properties":{
        "fileName":{
            "type":"string",
            "description":"The name of the debug log data file.",
            "readOnly":true
        },
        "mimeType":{
            "type":"string",
            "description":"The MIME type of the debug log data file.",
            "readOnly":true
        },
        "base64":{
            "type":"string",
            "format":"byte",
            "description":"The binary content of the debug log as a base-64 encoded string.",
            "readOnly":true,
            "example":"QmFzZS02NCBkYXRhLg=="
        }
    },
    "additionalProperties":false
}

Nested Schema : deploymentDebugEvents

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/debugEvent"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object debugEvent

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/debugEvent"
    }
}

Nested Schema : debugEvent

Type: object

Show Source

• content: object debugEventContent
• contentFileName: string
  Read Only: true

  The name of the debug event data file.
• contentMimeType: string
  Read Only: true

  The MIME type of the debug event data file.
• date: string (date-time)
  Read Only: true

  The date and time the event occurred.
• description: string
  Read Only: true

  The description of the event.
• id: number (double)
  Read Only: true

  The unqiue identifier for the debug event.
• name: string
  Read Only: true

  The name of the event.
• outcome: string
  Read Only: true

  The outcome of the event.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "format":"double",
            "description":"The unqiue identifier for the debug event.",
            "readOnly":true
        },
        "date":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time the event occurred.",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"The name of the event.",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "description":"The description of the event.",
            "readOnly":true
        },
        "outcome":{
            "type":"string",
            "description":"The outcome of the event.",
            "readOnly":true
        },
        "contentMimeType":{
            "type":"string",
            "description":"The MIME type of the debug event data file.",
            "readOnly":true
        },
        "contentFileName":{
            "type":"string",
            "description":"The name of the debug event data file.",
            "readOnly":true
        },
        "content":{
            "readOnly":true,
            "$ref":"#/components/schemas/debugEventContent"
        }
    },
    "additionalProperties":false
}

Nested Schema : debugEventContent

Type: object

Show Source

• base64: string (byte)
  Read Only: true

  The binary content of the debug event data file as a base-64 encoded string.

  Example: QmFzZS02NCBkYXRhLg==
• fileName: string
  Read Only: true

  The name of the debug event data file.
• mimeType: string
  Read Only: true

  The MIME type of the debug event data file.

{
    "type":"object",
    "properties":{
        "fileName":{
            "type":"string",
            "description":"The name of the debug event data file.",
            "readOnly":true
        },
        "mimeType":{
            "type":"string",
            "description":"The MIME type of the debug event data file.",
            "readOnly":true
        },
        "base64":{
            "type":"string",
            "format":"byte",
            "description":"The binary content of the debug event data file as a base-64 encoded string.",
            "readOnly":true,
            "example":"QmFzZS02NCBkYXRhLg=="
        }
    },
    "additionalProperties":false
}

Back to Top