Transcoding & Packaging API Guide

This document guides how to use PallyCon Transcoding & Packaging (T&P) service through HTTP API.

Common Specifications

The specifications below are common to all T&P APIs described in this document.

Authentication Token

When calling the T&P API, you need to set an authentication token issued by the process below.

Step 1: Generate the base64 encoded Authorization parameter

  1. Navigate to Base64 Enc/Dec page on PallyCon DevConsole.
  2. While Encrypt option is selected, enter the AccountID:AccessKey value in the left text field.
  3. Base64 encoded output will be displayed as the screenshot below.
  4. Copy the output value to use in the next step.

You need to input the AccountID and AccessKey values for your PallyCon service account.

Step 2: Use the parameter value to generate the Authorization token.

Call the token API URL with base64 encoded value in the Authorization request header.

Path Parameter

Parameter Format Description
siteId four alphanumeric characters Your PallyCon Site ID shown on Console

Request Header

Name Description
Authorization Basic Auth : Basic base64encode(accountId:accessKey)

Sample Request

GET /api/token/DEMO HTTP/1.1
Authorization: basic authInfo
Host: tnp.pallycon.com

Response Data Fields

Field Name Type Info
error_code String error code
error_message String error message
data.token String api auth token

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 112
{
  "error_code" : "0000",
  "error_message" : "Success.",
  "data" : {
    "token" : "Bearer valid-token"
  }
} 

API Request Header

You can call the T&P API by setting the data issued through the token api in the authorization header.

Common Response Specifications

Response Status

HTTP Status Code Description
Error code Description
401 Incorrect JWT Token specification or user information not found
403 You do not have permission to use the API.
200 Success

Response Data Fields

Key type Value
error_code String 0000: Success / Other values indicate failure
error_message String Error message
data Json Api result

Region Codes

Some of T&P APIs use region codes as below in the request and response data.

Region Code Region Name AWS Region Code
RG004 Oregon us-west-2
RG009 Frankfurt eu-central-1
RG010 Tokyo ap-northeast-1
RG011 Seoul ap-northeast-2
RG013 Singapore ap-southeast-1

Job API

Create Job

The API used to create the Transcoding and Packaging Job

Path Parameters
Parameter Description
siteId Your PallyCon Site ID (four alphanumeric characters)
Request Fields
Field Type Required Description
job_name String true Job name
content_id String true Content id
input Object true Input content information
input.storage_id String true Input storage id
input.files Array true Input files information.
input.files.[].file_type String true file type : multi, video, audio
- multi : Use the video and audio track of the input file. Audio track information must be included.
- video: Use the video track of the input file. Audio track information is not used. multi and video cannot be used together in the same job.
- audio: Use the audio track of the input file. Audio track information must be included.
input.files.[].file_path String true input file path
input.files.[].audios. Array audio information
input.files.[].audios.[].in Object true input audio track
input.files.[].audios.[].in.track Number input audio track index. default: 0
input.files.[].audios.[].remap Object true remapped audio track
input.files.[].audios.[].remap.track Number remapped audio track index. default: 0
input.subtitles Array Subtitle
input.subtitles.[].file_path String true subtitle file path
input.subtitles.[].language String true subtitle language
output Object true Output task information
output.storage_id String true Output storage id
output.path String true Output folder path
output.default_language String Default language code of audio track
output.transcodings Array true Transcoding
output.transcodings.[].track_id String true track id
output.transcodings.[].track_type String true track type : video, audio
output.transcodings.[].track_name String track name : audio
output.transcodings.[].codec String true video/audio code name (video: h264, h265. audio: aac, aac_lc…​
output.transcodings.[].height Number true(video) Height of video
output.transcodings.[].width Number true(video) Width of video
output.transcodings.[].bitrate_mode String Bitrate mode (cbr, vbr)
output.transcodings.[].bitrate Number true(cbr) Bitrate (bps).
output.transcodings.[].min_bitrate Number Minimum bitrate (bps). for vbr.
output.transcodings.[].max_bitrate Number Maximum bitrate (bps). for vbr.
output.transcodings.[].bandwidth Number bandwidth of video
output.transcodings.[].sample_rate Number Sample rate of audio
output.transcodings.[].language String Language code(ISO 639-1, lowercase two-letter) of audio track
output.transcodings.[].sources Array List of remapped audio tracks to use.
output.transcodings.[].sources.[].track Number remapped audio track index to use.
output.packaging Object true Packaging
output.packaging.dash Boolean output dash. Either dash or hls is required.
output.packaging.hls Boolean output hls. Either dash or hls is required.
output.packaging.option Object packaging option
output.packaging.option.min_buffer_time Number Specifies, in seconds, a common duration used in the definition of the MPD Representation data rate. Minimum: 2
output.packaging.option.enable_average_bandwidth_mpd Boolean Use average bandwidth for each track in MPD. (default: false)
output.packaging.option.mp4_subtitle Boolean the output subtitle format can be set to Embedded MP4 with this parameter. If the parameter is omitted, the subtitle in Text VTT format is created by default. (default: false)
output.drm Object Drm
output.drm.enabled Boolean Drm enable flag. default: false
output.drm.option Object Drm option
output.drm.option.multi_key Boolean Enables multi-key packaging. default: false
output.drm.option.max_sd_height Number Max resolution to be packaged as SD track. default: 480
output.drm.option.max_hd_height Number Max resolution to be packaged as HD track. default: 1080
output.drm.option.max_uhd1_height Number Max resolution to be packaged as UHD track. default: 2160
output.drm.option.skip_audio_encryption Boolean Disable audio track encryption. default: false(encrypt audio)
output.drm.option.clear_lead Number Unencrypted section at the beginning (by second). default: 0
output.drm.option.generate_tracktype_manifests Boolean Create multiple manifest (playlist) files for multi-key packaging. For adaptive streams containing SD to UHD tracks, three manifests are created: SD_ONLY, SD_HD, and SD_UHD. default: false
output.forensic_watermarking Object Forensic watermarking
output.forensic_watermarking.enabled Boolean Forensic watermarking enable flag. default: false

Sample Request

POST /api/job/DEMO HTTP/1.1
Authorization: Bearer valid_token
Content-Type: application/json;charset=UTF-8
Content-Length: 1541
Host: tnp.pallycon.com

{
  "job_name" : "jobName",
  "content_id" : "test-cid",
  "input" : {
    "storage_id" : "input-storage-id",
    "files" : [ {
      "file_type" : "multi",
      "file_path" : "input/input-file1.mp4",
      "audios" : [ {
        "in" : {
          "track" : 0
        },
        "remap" : {
          "track" : 0
        }
      } ]
    } ],
    "subtitles" : [ {
      "file_path" : "input/subtitle/en.vtt",
      "language" : "eng"
    } ]
  },
  "output" : {
    "storage_id" : "output-storage-id",
    "path" : "output",
    "transcodings" : [ {
      "track_id" : "video1",
      "track_type" : "video",
      "codec" : "h264",
      "height" : 1080,
      "width" : 1920,
      "bitrate_mode" : "CBR",
      "bitrate" : 10000,
      "frame_rate" : 23.98
    }, {
      "track_id" : "audio1",
      "track_type" : "audio",
      "track_name" : "english",
      "codec" : "h264",
      "bitrate_mode" : "CBR",
      "bitrate" : 128000,
      "language" : "en",
      "sources" : [ ]
    } ],
    "packaging" : {
      "dash" : true,
      "hls" : true,
      "option" : {
        "min_buffer_time" : 2,
        "enable_average_bandwidth_mpd" : false
      }
    },
    "drm" : {
      "enabled" : true,
      "option" : {
        "multi_key" : false,
        "max_sd_height" : 0,
        "max_hd_height" : 0,
        "max_uhd1_height" : 0,
        "skip_audio_encryption" : false,
        "clear_lead" : 0,
        "generate_tracktype_manifests" : false
      }
    },
    "forensic_watermarking" : {
      "enabled" : true
    }
  }
} 

Response Data Fields

Field Type Description
error_code String error code
error_message String error message
data.job_id Number created job id

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 96

{
  "error_code" : "0000",
  "error_message" : "Success.",
  "data" : {
    "job_id" : 123
  }
} 

Search Job List

Use this API to search the Job List

Path Parameters

Parameter Description
siteId Your PallyCon Site ID

Request Parameters

Parameter Description
from Search parameter for job registration time. (YYYY-MM-DD)
to Search parameter for job registration time. (YYYY-MM-DD)
job_name Search job name.
region Search region code.
page_unit Number of max result per page. default : 25, max: 1000.
page_index Index of result page. default : 1
job_id Search job id.
content_id Search content id.
security Search security type : drm / forensic_watermark
streaming_format Search streaming format : dash / hls
time_zone Search timezone. default : +00:00

Sample Request

GET /api/job/DEMO?from=2022-05-01&to=2022-05-13&job_name=test-job&region=RG011&page_unit=20&page_index=1&job_id=123&content_id=test-content-id&security=forensic_watermark&streaming_format=dash&time_zone=%2B00%3A00 HTTP/1.1
Authorization: Bearer valid_token
Content-Type: application/json;charset=UTF-8
Host: tnp.pallycon.com 

Response Data Fields

Field Type Description
error_code String Error code
error_message String Error message
time_zone String Timezone
total_count Number total count
data Array Job list
data.[].job_id Number Job ID
data.[].job_name String Job name
data.[].content_id String Content id
data.[].job_status String Job status code
data.[].drm Boolean Use DRM
data.[].forensic_watermark Boolean Use Forensic watermark
data.[].dash Boolean Packaging Dash
data.[].hls Boolean packaging Hls
data.[].region String Job registration region
data.[].reg_time String Job registration time.
data.[].start_time String Start time for the job
data.[].update_time String Last update time for the job

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 933

{
  "error_code" : "0000",
  "error_message" : "Success.",
  "time_zone" : "+00:00",
  "total_count" : 3,
  "data" : [ {
    "job_id" : 1,
    "job_name" : "test job 1",
    "content_id" : "test cid 1",
    "job_status" : "TP100200",
    "drm" : true,
    "forensic_watermark" : true,
    "dash" : true,
    "hls" : true,
    "region" : "RG011",
    "reg_time" : "2022-05-20T00:00:00"
  }, {
    "job_id" : 2,
    "job_name" : "test job 2",
    "content_id" : "test cid 2",
    "job_status" : "TP500",
    "drm" : true,
    "forensic_watermark" : false,
    "dash" : true,
    "hls" : false,
    "region" : "RG011",
    "reg_time" : "2022-05-20T00:00:00"
  }, {
    "job_id" : 3,
    "job_name" : "test job 3",
    "content_id" : "test cid 3",
    "job_status" : "TP700200",
    "drm" : true,
    "forensic_watermark" : true,
    "dash" : true,
    "hls" : true,
    "region" : "RG011",
    "reg_time" : "2022-05-20T00:00:00"
  } ]
} 

Get Job Detail

This API is used to Get the Job details

Path Parameters

Parameter Description
siteId Your PallyCon Site ID
jobId Job ID

Request Parameters

Parameter Required Description
time_zone yes Search timezone. default: +00:00

Sample Request

GET /api/job/DEMO/1?time_zone=%2B00%3A00 HTTP/1.1
Authorization: Bearer valid_token
Content-Type: application/json;charset=UTF-8
Host: tnp.pallycon.com 

Response Data Fields

Field Type Description
error_code String error code
error_message String error message
time_zone String Timezone
data Object Job Information
data.job_id Number Job Id
data.job_name String Job name
data.job_status String Job status code
data.region String Region code
data.content_id String Content id
data.input Object Input content information
data.input.storage_id String Input storage id
data.input.files Array Input files information.
data.input.files.[].file_type String file type : multi, video, audio
- multi : Use the video and audio track of the input file. Audio track information must be included.
- video: Use the audio track of the input file. Audio track information is not used. Multi and video cannot be used together in the same job.
- audio: Use the audio track of the input file. Audio track information must be included.
data.input.files.[].file_path String input file path
data.input.files.[].audios Array audio information
data.input.files.[].audios.[].in.track Number input audio track index
data.input.files.[].audios.[].remap.track Number remapped audio track index
data.input.subtitles Array Subtitle
data.input.subtitles.[].file_path String subtitle file path
data.input.subtitles.[].language String subtitle language
data.output Object Output task information
data.output.storage_id String Output storage id
data.output.path String Output folder path
data.output.transcodings Array Transcoding
data.output.transcodings.[].track_id String track id
data.output.transcodings.[].track_type String track type : video, audio
data.output.transcodings.[].track_name String track name : audio
data.output.transcodings.[].codec String video/audio code name (video: h264, h265. audio: aac, aac_lc…​
data.output.transcodings.[].height Number Height of video
data.output.transcodings.[].width Number Width of video
data.output.transcodings.[].bitrate_mode String Bitrate mode (cbr, vbr)
data.output.transcodings.[].bitrate Number Bitrate (bps).
data.output.transcodings.[].min_bitrate Number Minimum bitrate (bps). for vbr.
data.output.transcodings.[].max_bitrate Number Maximum bitrate (bps). for vbr.
data.output.transcodings.[].frame_rate Number Frame rate of video
data.output.transcodings.[].bandwidth Number bandwidth of video
data.output.transcodings.[].sample_rate Number Sample rate of audio
data.output.transcodings.[].language String Language code(ISO 639-1, lowercase two-letter) of audio track
data.output.transcodings.[].sources Array List of remapped audio tracks to use.
data.output.transcodings.[].sources.[].track Number remapped audio track index to use.
data.output.packaging Object Packaging
data.output.packaging.dash Boolean output dash. Either dash or hls is required.
data.output.packaging.hls Boolean output hls. Either dash or hls is required.
data.output.packaging.option Object packaging option
data.output.packaging.option.min_buffer_time Number Specifies, in seconds, a common duration used in the definition of the MPD Representation data rate. Minimum: 2
data.output.packaging.option.enable_average_bandwidth_mpd Boolean Use average bandwidth for each track in MPD. (default: false)
data.output.packaging.option.mp4_subtitle Boolean the output subtitle format can be set to Embedded MP4 with this parameter. If the parameter is omitted, the subtitle in Text VTT format is created by default. (default: false)
data.output.drm Object Drm
data.output.drm.enabled Boolean Drm enable flag. default: false
data.output.drm.option Object Drm option
data.output.drm.option.multi_key Boolean Enables multi-key packaging. default: false
data.output.drm.option.max_sd_height Number Max resolution to be packaged as SD track. default: 480
data.output.drm.option.max_hd_height Number Max resolution to be packaged as HD track. default: 1080
data.output.drm.option.max_uhd1_height Number Max resolution to be packaged as UHD track. default: 2160
data.output.drm.option.skip_audio_encryption Boolean Disable audio track encryption. default: false(encrypt audio)
data.output.drm.option.clear_lead Number Unencrypted section at the beginning (by second). default: 0
data.output.drm.option.generate_tracktype_manifests Boolean Create multiple manifest (playlist) files for multi-key packaging. For adaptive streams containing SD to UHD tracks, three manifests are created: SD_ONLY, SD_HD, and SD_UHD. default: false
data.output.forensic_watermarking Object Forensic watermarking
data.output.forensic_watermarking.enabled Boolean Forensic watermarking enable flag. default: false
data.reg_time String Job registration time
data.start_time String Job start time
data.update_time String Last update time for the job

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1542

{
  "error_code" : "0000",
  "error_message" : "Success.",
  "time_zone" : "+00:00",
  "data" : {
    "job_name" : "jobName",
    "content_id" : "test-cid",
    "input" : {
      "storage_id" : "12312312312312312312312312312312",
      "files" : [ {
        "file_type" : "multi",
        "file_path" : "del-short-hevc.mp4",
        "audios" : [ {
          "in" : {
            "track" : 0
          },
          "remap" : {
            "track" : 0
          }
        } ]
      } ]
    },
    "output" : {
      "storage_id" : "32132132132132132132131231232132",
      "path" : "saas-pack",
      "transcodings" : [ {
        "track_id" : "video1",
        "track_type" : "video",
        "codec" : "H265",
        "height" : 1080,
        "width" : 1920,
        "bitrate" : 2500,
        "frame_rate" : 23.98
      }, {
        "track_id" : "video2",
        "track_type" : "video",
        "codec" : "H264",
        "height" : 720,
        "width" : 1080,
        "bitrate" : 1500,
        "frame_rate" : 23.98
      }, {
        "track_id" : "audio1",
        "track_type" : "audio",
        "codec" : "aac",
        "sources" : [ {
          "track" : 0
        } ]
      } ],
      "packaging" : {
        "dash" : true,
        "hls" : true
      },
      "drm" : {
        "enabled" : true
      },
      "forensic_watermarking" : {
        "enabled" : true
      }
    },
    "job_id" : 1,
    "region" : "RG011",
    "job_status" : "TP100100",
    "start_time" : "2022-05-20T17:03:41",
    "reg_time" : "2022-05-20T17:02:17"
  }
} 

Job Stop

The below API is used to stop the T&P job

Path Parameters

Parameter Description
siteId Your PallyCon Site ID
jobId Job ID

Sample Request

PUT /api/job/DEMO/1/stop HTTP/1.1
Authorization: Bearer valid_token
Content-Type: application/json;charset=UTF-8
Host: tnp.pallycon.com 

Response Data Fields

Field Type Description
error_code String error code
error_message String error message
data Object Job Information
data.job_id Number Job Id

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 94

{
  "error_code" : "0000",
  "error_message" : "Success.",
  "data" : {
    "job_id" : 1
  }
} 

Job Restart

API to restart the job.

Path Parameters

Parameter Description
siteId Your PallyCon Site ID
jobId Job ID

Sample Request

PUT /api/job/DEMO/1/restart HTTP/1.1
Authorization: Bearer valid_token
Content-Type: application/json;charset=UTF-8
Host: tnp.pallycon.com

Response Data Fields

Field Type Description
error_code String error code
error_message String error message
data Object Job Information
data.job_id Number Job Id

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 94

{
  "error_code" : "0000",
  "error_message" : "Success.",
  "data" : {
    "job_id" : 1
  }
} 

Storage API

Create Storage

API to create the storage ID

Path Parameters

Parameter Description
siteId Your PallyCon Site ID

Request Fields

Field Type Required Description
storage_name String true Name of the storage
aws_bucket String true Name of S3 bucket
io_type String true Storage input/output type
access_key_id String true S3 access key id
secret_key String true S3 secret key
region String true Region code
description String Storage description

Sample Request

POST /api/storage/DEMO HTTP/1.1
Authorization: Bearer valid_token
Content-Type: application/json;charset=UTF-8
Content-Length: 295
Host: tnp.pallycon.com

{
  "storage_name" : "test-input-storage",
  "aws_bucket" : "watermark-input-seoul",
  "io_type" : "input",
  "access_key_id" : "valid-test-storage-access-key-id",
  "secret_key" : "valid-in-test-storage-secret-key",
  "region" : "RG011",
  "description" : "This storage is test input bucket."
} 

Response Data Fields

Field Type Description
error_code String error code
error_message String error message
data.storage_id String created storage id

Sample Response

| HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "error_code" : "0000",
  "error_message" : "Success.",
  "data" : {
    "storage_id" : "input-storage-id"
  }
}

Search Storage List

API to search in the Storage List

Path Parameters

Parameter Description
siteId Your PallyCon Site ID

Request Parameters

Parameter Description
from Search parameter for storage registration time. (YYYY-MM-DD)
to Search parameter for storage registration time. (YYYY-MM-DD)
storage_name Search storage name.
region Search storage region code.
page_unit Number of max result per page. default : 25, max: 1000.
page_index Index of result page. default : 1
time_zone Search timezone. default: +00:00

Sample Request

GET /api/storage/DEMO?from=2022-05-01&to=2022-05-13&storage_name=test-storage&region=RG011&page_unit=20&page_index=1&time_zone=%2B00%3A00 HTTP/1.1
Authorization: Bearer valid_token
Content-Type: application/json;charset=UTF-8
Host: tnp.pallycon.com 

Response Data Fields

Field Type Description
error_code String Error code
error_message String Error message
time_zone String Timezone
data Array Storage list
data.[].storage_id String Storage id
data.[].storage_name String Storage name
data.[].aws_bucket String Bucket name
data.[].io_type String input / output
data.[].region String Storage region
data.[].reg_time String Storage registration time YYYY-MM-DD’T’hh-mm-ss
data.[].update_time String Last update time YYYY-MM-DD’T’hh-mm-ss

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 775

{
  "error_code" : "0000",
  "error_message" : "Success.",
  "time_zone" : "+00:00",
  "data" : [ {
    "storage_id" : "e42e5fc74bee455db0fc2d79038dbabb",
    "storage_name" : "test storage 1",
    "aws_bucket" : "test bucket 1",
    "io_type" : "input",
    "region" : "RG011",
    "reg_time" : "2022-05-20T00:00:00"
  }, {
    "storage_id" : "50273cb8e91242f3ad6b9dd49faf8f03",
    "storage_name" : "test storage 2",
    "aws_bucket" : "test bucket 2",
    "io_type" : "input",
    "region" : "RG011",
    "reg_time" : "2022-05-20T00:00:00"
  }, {
    "storage_id" : "69798b703f3c46b996a1335a54c3fa0e",
    "storage_name" : "test storage 3",
    "aws_bucket" : "test bucket 3",
    "io_type" : "input",
    "region" : "RG011",
    "reg_time" : "2022-05-20T00:00:00"
  } ]
}  

Get Storage Detail

API to get the storage details

Path Parameters

Parameter Description
siteId Your PallyCon Site ID
storageId Storage id

Request Parameters

Parameter Description
time_zone Search timezone. default: +00:00

Sample Request

GET /api/storage/DEMO/12312312312312312312312312312312?time_zone=%2B00%3A00 HTTP/1.1
Authorization: Bearer valid_token
Content-Type: application/json;charset=UTF-8
Host: tnp.pallycon.com 

Response Data Fields

Field Type Description
error_code String error code
error_message String error message
time_zone String Timezone
data Object Storage Information
data.storage_id String Storage Id
data.storage_name String Storage name
data.io_type String Storage input/output type
data.aws_bucket String Bucket name
data.region String Region code
data.access_key_id String Storage access key id
data.secret_key String storage secret key
data.description String Storage Description
data.reg_time String Storage registration time (YYYY-MM-DD’T’hh-mm-ss)
data.update_time String Last update time

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 547

{
  "error_code" : "0000",
  "error_message" : "Success.",
  "time_zone" : "+00:00",
  "data" : {
    "storage_id" : "12312312312312312312312312312312",
    "storage_name" : "test-input-storage",
    "io_type" : "input",
    "aws_bucket" : "watermark-input-seoul",
    "region" : "RG011",
    "access_key_id" : "valid-test-storage-access-key-id",
    "secret_key" : "valid-in-test-storage-secret-key",
    "description" : "This storage is test input bucket.",
    "update_time" : "2022-05-26T05:43:01",
    "reg_time" : "2022-05-25T05:43:01"
  }
} 

Update Storage

API to update the storage details

Path Parameters

Parameter Description
siteId Your PallyCon Site ID
storageId Storage id
Request Fields
Field Type Description
storage_name String Storage name
access_key_id String S3 access key id
secret_key String S3 secret key
aws_bucket String S3 bucket name
io_type String input / output
description String Storage description

Sample Request

PUT /api/storage/DEMO/12312312312312312312312312312312 HTTP/1.1
Authorization: Bearer valid_token
Content-Type: application/json;charset=UTF-8
Content-Length: 217
Host: tnp.pallycon.com

{
  "storage_name" : "test-input-storage",
  "aws_bucket" : "watermark-input-seoul",
  "io_type" : "input",
  "access_key_id" : "valid-test-storage-access-key-id",
  "secret_key" : "valid-in-test-storage-secret-key"
} 

Response Data Fields

Field Type Description
error_code String error code
error_message String error message
data Object Storage Information
data.storage_id String Storage Id

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 131

{
  "error_code" : "0000",
  "error_message" : "Success.",
  "data" : {
    "storage_id" : "12312312312312312312312312312312"
  }
} 

Delete Storage ID

API to delete storage ID

Path Parameters

Parameter Description
siteId Your PallyCon Site ID
storageId Storage ID

Sample Request

DELETE /api/storage/DEMO/12312312312312312312312312312312 HTTP/1.1
Authorization: Bearer valid_token
Content-Type: application/json;charset=UTF-8
Host: tnp.pallycon.com

Response Data Fields

Field Type Description
error_code String error code
error_message String error message
data Object Storage Information
data.storage_id String Storage Id

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 131

{
  "error_code" : "0000",
  "error_message" : "Success.",
  "data" : {
    "storage_id" : "12312312312312312312312312312312"
  }
}  

Delete Multiple Storages

API to delete multiple storage IDs at once.

Path Parameters

Parameter Description
siteId Your PallyCon Site ID
storage_ids Array

Sample Request

DELETE /api/storage/DEMO HTTP/1.1
Authorization: Bearer valid_token
Content-Type: application/json;charset=UTF-8
Content-Length: 118
Host: tnp.pallycon.com

{
  "site_id" : "DEMO",
  "storage_ids" : [ "12312312312312312312312312312312", "12312312312312312312312312312313" ]
} 

Response Data Fields

Field Type Description
error_code String error code
error_message String error message
data Object Storage Information
data.site_id String Site id
data.storage_ids Array Storage Id list

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 196

{
  "error_code" : "0000",
  "error_message" : "Success.",
  "data" : {
    "site_id" : "DEMO",
    "storage_ids" : [ "12312312312312312312312312312312", "12312312312312312312312312312313" ]
  }
}
Previous
Next