API EndPoint

Summary

Step 1: Obtaining an API Token

Access to a Jornaya account is guarded by API Access Tokens, which is used as the Bearer Token when performing a query. An API Access token is required to post a file to Jornaya using the API endpoint.

1. Log in to the myJornaya User Interface to retrieve the information needed to perform the API call.

2. Navigate to the "Manage API tokens" page from the top right button or using this URL:

   1. https://app.jornaya.com/activate/access-tokens

3. Create a new token by clicking the "Add API Token" button in the top left of the page. Confirm the new record on the page contains today’s date in the "Created" column. If an API token already exists, any can be used.
   

   

Step 2: Obtain Activate Instance ID

Each Activate Instance has a unique instance ID. The Activate instance ID is needed in the API call to post a monitoring file to Jornaya. The Instance ID can be accessed in two different ways:

Step 3: Retrieve the Upload URL and Information Necessary to POST a File

Step 4: Posting the File to Jornaya

A POST call should now be performed that includes the data points below. The values listed are retrieved from the previous call to the "GET Upload URL Endpoint" and enable the file to be sent to the specific Activate Instance ID desired.

Perform a POST call using the values below

• URL: Retrieved from the previous GET call. This is the URL the file will post into

• These values must be included in the body of the POST as form-data key-value pairs:

key
x-amz-algorithm
x-amz-credential
x-amz-date
x-amz-security-token
policy
x-amz-signature
File: Location of the monitoring file you wish to post

Sample Request

curl --location --request POST 'INSERT URL' \
--form 'Key="INSERT KEY"' \
--form 'x-amz-algorithm="INSERT X-AMZ-ALGORITHM"' \
--form 'x-amz-credential="INSERT X-AMZ-CREDENTIAL"' \
--form 'x-amz-date="INSERT INSERT X-AMZ-DATE"' \
--form 'x-amz-security-token="INSERT INSERT X-AMZ-SECURITY-TOKEN"' \
--form 'policy="INSERT POLICY' \
--form 'x-amz-signature="INSERT INSERT X-AMZ-SIGNATURE"' \
--form 'File="Get-Item -Path '\''INSERT FILE PATH'\''"'

API Responses

If the Upload has completed successfully the response will be empty but the request will result in a request code of "200".

• Once a file is fully ingested it will run through a validation process (approximately 5 minutes to complete).

• From the Activate Instances page, click on "Run Results" button to view the most recent signal output.

  

If the Upload resulted in an error

• Validation results can be downloaded that describe the nature of the error from this screen in myJornaya.

• Jornaya Support may also reach out regarding any errors that occurred and how to correct them.

  

Step 5: Confirming the File was Received

Open the Activate instance in within myJornaya and check the “Data Source” section to confirm the file has been loaded successfully.