Download Code Signed Files

This API allows users to download code-signed files that have been digitally signed and verified, ensuring the integrity and authenticity of the downloaded content.

Before you begin

  • Ensure successful signing of the file from the Signing Inventory
  • Ensure you have the Sign ID of the code-signed file that you intend to download.

Request Structure

Endpoint: /code-signing-download-signed-file
Type: POST
Sample URL: https://<IP/HostName/TenantName>:<GWPORT>/avxapi/code-signing-download-signed-file?gwsource=external

To understand the elements of the sample URL, click here.
Content-Type: application/json
Table 1. Input Parameters
Name Description
sessionId

Header

 (Mandatory) After successfully logging in, a unique identifier assigned to a user's session after successful authentication. The session ID remains valid until it expires. The session ID is a string value.

Example: "a1b2c3d4e5f6"
username

Header

 (Mandatory) AppViewX login username, represented as a string value.

Example: "User"
password

Header

 (Mandatory) AppViewX login username, represented as a string value.

Example: "AppViewX@123"
Payload (Mandatory) Input data for request body in application/json format. For payload details, see Payload section.

Payload

Name Description
signId

String

Payload

 (Mandatory) Enter the Sign ID received after signing the code, which is a string value.

Example: "651baff382ca812a7cbf4baa"

Response Structure

  • Status Code: 200 OK
  • Message: Successful
  • Headers:
    • Content-Type: application/json
  • Response: Signed File is downloaded.

Status Codes

HTTP Code appStatusCode Response Message
200 Ok null Successful
400 Payload entered is Invalid. VALIDATION_ERROR _0004 Input fields do not comply with the validation criteria. Please recheck the input payload::[Id is mandatory]
400 SignId entered is invalid. VALIDATION_ERROR _0004 Invalid 'signId
403 Invalid permissions. CODE_SIGNING_0076 Permissions are not there to download the signed file for the given input
500 SignId does not exist. CODE_SIGNING_0068 Sign Id Does not Exist.
500 Invalid input. CODE_SIGNING_0069 Download action can not be performed on Hash Based Signing/Failed status entry.
500 Unavailability of resources. CODE_SIGNING_0014 Download operation failed for the given sign id

Sample Request/Response

Use Case

To download a code signed file using Sign Id.

Request URL 
https://<IP/HostName/TenantName>:<GWPORT>/avxapi/code-signing-download-signed-file?gwsource=external
Request Payload 
{
Payload : {
signId: "651baff382ca812a7cbf4baa"
}
}
Sample Response 
Signed File

Reference

Understanding the sample URL:
  • IP/HostName/TenantName: Replace with the actual IP address, hostname, or tenant name based on the specific configuration in AppViewX.
    • IP: A unique identifier assigned to each device connected to a computer network that uses the Internet Protocol for communication

      The IP address will be included in the endpoint URL for an on-prem deployment.

    • HostName: A human-readable label assigned to a device (host) on a network

      The hostname will be included in the endpoint URL for an on-prem deployment.

    • TenantName: An identifier label for a tenant given to indicate which tenant's data the API request will access/modify

      The tenant name will be included in the endpoint URL for a SaaS deployment.

  • GWPORT: AppViewX gateway port

    A gateway port refers to a network port through which data is sent and received to communicate with a gateway in an on-prem deployment.

    Example: 31443

  • avxapi: Path parameter value (static) that is part of the endpoint's URL
  • Endpoint: Endpoint of the API, for example: execute-hook
  • gwsource: Source or origin of a gateway, for example: external.