Docusign RequestLogs API

openapi: 3.2.0
info:
  title: Docusign Request Logs API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged RequestLogs across 2 of this provider''s published API definitions: docusign-openapi-original.yml, docusign-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.docusign.net/restapi
tags:
- name: RequestLogs
  description: 'The RequestLogs resource provide methods that allow you to retrieve and delete the API request log files.


    The log files contain the API requests associated with your integration. They can aid you in troubleshooting specific issues within an integration, or if DocuSign Support requests an API trace log.'
paths:
  /v2/diagnostics/request_logs:
    get:
      tags:
      - RequestLogs
      summary: Docusign Gets the API request logging log files
      description: 'Retrieves a list of log entries as a JSON or xml object or as a zip file containing the entries.


        If the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request.


        If the Accept header is set to `application/json` or `application/xml`, the response returns list of log entries in either JSON or XML. An example JSON response body is shown below.'
      operationId: APIRequestLog_GetRequestLogs
      parameters:
      - name: encoding
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/apiRequestLogsResult'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: listRequestLogs
      x-ds-method: list
      x-ds-service: Diagnostics
      x-ds-in-sdk: true
    delete:
      tags:
      - RequestLogs
      summary: Docusign Deletes the request log files
      description: Deletes the request log files.
      operationId: APIRequestLog_DeleteRequestLogs
      responses:
        '200':
          description: Successful response.
          content: {}
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: deleteRequestLogs
      x-ds-method: delete
      x-ds-service: Diagnostics
      x-ds-in-sdk: true
    servers:
    - url: https://www.docusign.net/restapi
  /v2/diagnostics/request_logs/{requestLogId}:
    get:
      tags:
      - RequestLogs
      summary: Docusign Gets a request logging log file
      description: 'Retrieves information for a single log entry.


        **Request**

        The `requestLogfId` property can be retrieved by getting the list of log entries. The Content-Transfer-Encoding header can be set to base64 to retrieve the API request/response as base 64 string. Otherwise the bytes of the request/response are returned.


        **Response**

        If the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string.'
      operationId: APIRequestLog_GetRequestLog
      parameters:
      - name: requestLogId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            text/plain:
              schema:
                type: string
                format: binary
        '400':
          description: Error encountered.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getRequestLog
      x-ds-method: get
      x-ds-service: Diagnostics
      x-ds-in-sdk: true
    servers:
    - url: https://www.docusign.net/restapi
  /v2/diagnostics/settings:
    get:
      tags:
      - RequestLogs
      summary: Docusign Gets the API request logging settings
      description: 'Retrieves the current API request logging setting for the user and remaining log entries.


        **Response**

        The response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries.'
      operationId: APIRequestLog_GetRequestLogSettings
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/diagnosticsSettingsInformation'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getRequestLogSettings
      x-ds-method: getSettings
      x-ds-service: Diagnostics
      x-ds-in-sdk: true
    put:
      tags:
      - RequestLogs
      summary: Docusign Enables or disables API request logging for troubleshooting
      description: 'Enables or disables API request logging for troubleshooting.


        When enabled (`apiRequestLogging` is set to true), REST API requests and responses for the user are added to a log. A log can have up to 50 requests/responses and the current number of log entries can be determined by getting the settings. Logging is automatically disabled when the log limit of 50 is reached.


        You can call [ML:GetRequestLog] or [ML:GetRequestLogs] to download the log files (individually or as a zip file). Call [ML:DeleteRequestLogs] to clear the log by deleting current entries.


        Private information, such as passwords and integrator key information, which is normally located in the call header is omitted from the request/response log.


        ###### Note: API request logging only captures requests from the authenticated user. Any call that does not authenticate the user and resolve a userId isn''t logged. Meaning that login_information, NewAccounts, or other distributor-credential calls are not logged.'
      operationId: APIRequestLog_PutRequestLogSettings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/diagnosticsSettingsInformation'
          application/xml:
            schema:
              $ref: '#/components/schemas/diagnosticsSettingsInformation'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/diagnosticsSettingsInformation'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: updateRequestLogSettings
      x-ds-method: updateSettings
      x-ds-service: Diagnostics
      x-ds-in-sdk: true
      x-codegen-request-body-name: diagnosticsSettingsInformation
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/diagnostics/request_logs:
    parameters: []
    get:
      tags:
      - RequestLogs
      summary: Gets the API request logging log files
      description: 'Retrieves a list of log entries as a JSON or XML object or as a zip file containing the entries.


        If the Accept header is set to `application/zip`, the response is a zip file containing individual text files, each representing an API request.


        If the Accept header is set to `application/json` or `application/xml`, the response returns list of log entries in either JSON or XML. An example JSON response body is shown below.'
      operationId: getV21DiagnosticsRequestLogs
      parameters:
      - name: encoding
        in: query
        required: false
        description: Reserved for Docusign.
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiRequestLogsResult_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: listRequestLogs
      x-ds-method: list
      x-ds-service: Diagnostics
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: APIRequestLog_GetRequestLogs
    delete:
      tags:
      - RequestLogs
      summary: Deletes the request log files
      description: Deletes the request log files.
      operationId: deleteV21DiagnosticsRequestLogs
      responses:
        '200':
          description: Successful response.
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: deleteRequestLogs
      x-ds-method: delete
      x-ds-service: Diagnostics
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: APIRequestLog_DeleteRequestLogs
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/diagnostics/request_logs/{requestLogId}:
    parameters: []
    get:
      tags:
      - RequestLogs
      summary: Gets a request logging log file
      description: 'Retrieves information for a single log entry.


        **Request**

        The `requestLogId` property can be retrieved by getting the list of log entries. The Content-Transfer-Encoding header can be set to base64 to retrieve the API request/response as base 64 string. Otherwise the bytes of the request/response are returned.


        **Response**

        If the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string.'
      operationId: getV21DiagnosticsRequestLogsByRequestLogId
      parameters:
      - name: requestLogId
        in: path
        required: true
        description: The ID of the log entry.
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            text/plain:
              schema:
                type: string
                format: binary
        '400':
          description: Error encountered.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: getRequestLog
      x-ds-method: get
      x-ds-service: Diagnostics
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: APIRequestLog_GetRequestLog
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/diagnostics/settings:
    parameters: []
    get:
      tags:
      - RequestLogs
      summary: Gets the API request logging settings
      description: 'Retrieves the current API request logging setting for the user and remaining log entries.


        **Response**

        The response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries.'
      operationId: getV21DiagnosticsSettings
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/diagnosticsSettingsInformation_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: getRequestLogSettings
      x-ds-method: getSettings
      x-ds-service: Diagnostics
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: APIRequestLog_GetRequestLogSettings
    put:
      tags:
      - RequestLogs
      summary: Enables or disables API request logging for troubleshooting
      description: 'Enables or disables API request logging for troubleshooting.


        When enabled (`apiRequestLogging` is **true**),

        REST API requests and responses for the user are added to a log.

        A log can have up to 50 requests/responses

        and the current number of log entries can be determined

        by getting the settings.

        Logging is automatically disabled when the log limit of 50 is reached.


        You can call

        Diagnostics: getRequestLog

        or

        Diagnostics: listRequestLogs

        to download the log files (individually or as a zip file).

        Call Diagnostics: deleteRequestLogs

        to clear the log by deleting current entries.


        Private information, such as passwords and integration key information,

        which is normally located in the call header is omitted from the request/response log.


        API request logging only captures requests from the authenticated user.

        Any call that does not authenticate the user and resolve a userId is not logged.'
      operationId: putV21DiagnosticsSettings
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/diagnosticsSettingsInformation_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: updateRequestLogSettings
      x-ds-method: updateSettings
      x-ds-service: Diagnostics
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/diagnosticsSettingsInformation_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/diagnosticsSettingsInformation_2'
      x-operation-id-source: normalized
      x-operation-id-original: APIRequestLog_PutRequestLogSettings
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    diagnosticsSettingsInformation:
      type: object
      properties:
        apiRequestLogging:
          type: string
          description: ' When set to **true**, enables API request logging for the user. '
        apiRequestLogMaxEntries:
          type: string
          description: Specifies the maximum number of API requests to log.
        apiRequestLogRemainingEntries:
          type: string
          description: Indicates the remaining number of API requests that can be logged.
      description: ''
      x-ds-definition-name: diagnosticsSettingsInformation
      x-ms-summary: ''
    apiRequestLogsResult:
      type: object
      properties:
        apiRequestLogs:
          type: array
          description: 'Reserved: TBD'
          items:
            $ref: '#/components/schemas/apiRequestLog'
      description: Contains information about mutiple API request logs.
      x-ds-definition-name: apiRequestLogsResult
      x-ms-summary: Contains information about mutiple API request logs.
    apiRequestLog:
      type: object
      properties:
        createdDateTime:
          type: string
          description: Indicates the date and time the item was created.
        description:
          type: string
          description: 'A sender-defined description of the line item.

            '
        requestLogId:
          type: string
          description: ''
        status:
          type: string
          description: Item status. <!-- TODO -->
      description: Contains API request log information.
      x-ds-definition-name: apiRequestLog
      x-ms-summary: Contains API request log information.
    errorDetails:
      type: object
      properties:
        errorCode:
          type: string
          description: An error code associated with the error.
        message:
          type: string
          description: A short error message.
      description: This object describes errors that occur. It is only valid for responses, and ignored in requests.
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses, and ignored in requests.
    diagnosticsSettingsInformation_2:
      type: object
      properties:
        apiRequestLogging:
          description: ' When **true,** enables API request logging for the user. '
          type: string
        apiRequestLogMaxEntries:
          description: Specifies the maximum number of API requests to log.
          type: string
        apiRequestLogRemainingEntries:
          description: Indicates the remaining number of API requests that can be logged.
          type: string
      x-ds-definition-name: diagnosticsSettingsInformation
      description: ''
      x-ms-summary: ''
    apiRequestLogsResult_2:
      description: Contains information about multiple API request logs.
      type: object
      properties:
        apiRequestLogs:
          description: Reserved for Docusign.
          type: array
          items:
            $ref: '#/components/schemas/apiRequestLog_2'
      x-ds-definition-name: apiRequestLogsResult
      x-ms-summary: Contains information about multiple API request logs.
    apiRequestLog_2:
      description: Contains API request log information.
      type: object
      properties:
        createdDateTime:
          description: The UTC DateTime when the item was created.
          type: string
        description:
          description: The API endpoint that was called.
          type: string
        requestLogId:
          description: The ID of the log entry.
          type: string
        status:
          description: The status of the API request.
          type: string
      x-ds-definition-name: apiRequestLog
      x-ms-summary: Contains API request log information.
    errorDetails_2:
      description: This object describes errors that occur. It is only valid for responses and ignored in requests.
      type: object
      properties:
        errorCode:
          description: The code associated with the error condition.
          type: string
        message:
          description: A brief message describing the error condition.
          type: string
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses and ignored in requests.
x-refined-from:
- docusign-openapi-original.yml
- docusign-openapi.json
x-ds-categories:
- name: UserManagement
  summary: Methods to manage users in an account.
  description: Methods to manage users in an account.
- name: BulkOperations
  summary: Methods to import and export users and accounts.
  description: Methods to import and export users and accounts.
- name: IdentityProviders
  summary: Methods to get a list of identity providers.
  description: Methods to get a list of identity providers.
- name: ReservedDomains
  summary: Methods to get a list of reserved domains.
  description: Methods to get a list of reserved domains.
- name: Organization
  summary: Methods for working with organizations.
  description: Methods for working with organizations.
x-original-swagger-version: '2.0'