Get manifest

curl --request GET \
  --url https://api.example.com/v1/data-apps/{app_id}/manifest

const options = {method: 'GET'};

fetch('https://api.example.com/v1/data-apps/{app_id}/manifest', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/data-apps/{app_id}/manifest",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/data-apps/{app_id}/manifest"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/data-apps/{app_id}/manifest")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

GET

data-apps

{app_id}

manifest

Get manifest

curl --request GET \
  --url https://api.example.com/v1/data-apps/{app_id}/manifest

const options = {method: 'GET'};

fetch('https://api.example.com/v1/data-apps/{app_id}/manifest', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/data-apps/{app_id}/manifest",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/data-apps/{app_id}/manifest"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/data-apps/{app_id}/manifest")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

GET https://api-datahub.octoparse.com/v1/data-apps/{app_id}/manifest Authentication: API key required (Authorization: Bearer <API Key>). App author only; others get 404. Author read-back of the latest Release full manifest (including the runtime block) — the data source for “edit then republish”. Zero releases return 404. Draft self-checks always go through the workspace endpoints; do not mix the two. runtime is a backend artifact and never appears in public payloads such as cards or detail views, so this endpoint is author-only. auth.secret is only an alias into runtime.env; credential plaintext lives in the secret store and is never leaked on read-back. status and scope are injected from current ops state, not the original manifest values. Manifests no longer carry identity.version; take version numbers from the version list.

Request

Path parameters

string

required

App reference.

Example request

curl \
  -H "Authorization: Bearer $OCTOPARSE_API_KEY" \
  "https://api-datahub.octoparse.com/v1/data-apps/carol/reviews-query/manifest"

Response

200 success

{
  "data": {
    "spec_version": "0.2",
    "identity": {
      "app_name": "probe-b",
      "name": "Runs list probe source",
      "summary": "Test app for runs list pagination and filters",
      "type": "data"
    },
    "discovery": {
      "keywords": [
        "runs-list-probe"
      ]
    },
    "input": {
      "schema": {
        "type": "object",
        "properties": {
          "product": {
            "type": "string"
          }
        },
        "required": [
          "product"
        ]
      }
    },
    "output": {
      "id_field": "review_id",
      "schema": {
        "type": "object",
        "properties": {
          "review_id": {
            "type": "string"
          }
        }
      }
    },
    "execution": {
      "mode": "sync",
      "timeout_seconds": 60
    },
    "pricing": {
      "events": [
        {
          "event": "record",
          "label": "Fetch one record",
          "unit_price": 0.001
        }
      ]
    },
    "runtime": {
      "kind": "api",
      "env": {
        "base": "PARTNER_API_BASE",
        "api_key": "PARTNER_API_KEY"
      },
      "api": {
        "auth": {
          "type": "api_key",
          "in": "header",
          "name": "X-API-Key",
          "secret": "api_key"
        },
        "response_code": {
          "path": "code",
          "ok_codes": [
            20000
          ],
          "message_path": "message"
        },
        "fetch": {
          "request": {
            "method": "GET",
            "url": "{env.base}/api/envelope/reviews",
            "query": {
              "product": "{input.product}"
            }
          },
          "response": {
            "records_path": "data.records",
            "field_map": {
              "review_id": "id"
            }
          }
        }
      }
    },
    "status": "published",
    "scope": "private",
    "namespace": "carol",
    "source_locale": "zh-CN"
  }
}

data is the manifest object itself (only the leading portion is shown above).

Errors

HTTP	`code`	`category`	Description
401	`unauthorized`	`forbidden`	Missing or invalid API key.
404	`release-not-found`	`not_found`	That version does not exist, or the app has no releases yet.

Error responses use {"error": {code, category, message, retryable}}. See Errors.

Client libraries

The Python and JavaScript SDKs do not wrap this endpoint yet. Call REST directly.

GET STARTED

QUICK START

REFERENCE

DATA HUB API

Get manifest

Request

Path parameters

Example request

Response

200 success

Errors

Client libraries

​Request

​Path parameters

​Example request

​Response

​200 success

​Errors

​Client libraries

Request

Path parameters

Example request

Response

200 success

Errors

Client libraries