Ingest Environment

curl --request POST \
  --url https://{host}/api/ingest/environment \
  --header 'Content-Type: application/json' \
  --data '
{
  "run_id": "<string>",
  "overview": {},
  "hardware": {},
  "packages": ""
}
'

import requests

url = "https://{host}/api/ingest/environment"

payload = {
    "run_id": "<string>",
    "overview": {},
    "hardware": {},
    "packages": ""
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({run_id: '<string>', overview: {}, hardware: {}, packages: ''})
};

fetch('https://{host}/api/ingest/environment', 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://{host}/api/ingest/environment",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'run_id' => '<string>',
    'overview' => [
        
    ],
    'hardware' => [
        
    ],
    'packages' => ''
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{host}/api/ingest/environment"

	payload := strings.NewReader("{\n  \"run_id\": \"<string>\",\n  \"overview\": {},\n  \"hardware\": {},\n  \"packages\": \"\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/api/ingest/environment")
  .header("Content-Type", "application/json")
  .body("{\n  \"run_id\": \"<string>\",\n  \"overview\": {},\n  \"hardware\": {},\n  \"packages\": \"\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/api/ingest/environment")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"run_id\": \"<string>\",\n  \"overview\": {},\n  \"hardware\": {},\n  \"packages\": \"\"\n}"

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

api

ingest

environment

Ingest Environment

curl --request POST \
  --url https://{host}/api/ingest/environment \
  --header 'Content-Type: application/json' \
  --data '
{
  "run_id": "<string>",
  "overview": {},
  "hardware": {},
  "packages": ""
}
'

import requests

url = "https://{host}/api/ingest/environment"

payload = {
    "run_id": "<string>",
    "overview": {},
    "hardware": {},
    "packages": ""
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({run_id: '<string>', overview: {}, hardware: {}, packages: ''})
};

fetch('https://{host}/api/ingest/environment', 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://{host}/api/ingest/environment",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'run_id' => '<string>',
    'overview' => [
        
    ],
    'hardware' => [
        
    ],
    'packages' => ''
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{host}/api/ingest/environment"

	payload := strings.NewReader("{\n  \"run_id\": \"<string>\",\n  \"overview\": {},\n  \"hardware\": {},\n  \"packages\": \"\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/api/ingest/environment")
  .header("Content-Type", "application/json")
  .body("{\n  \"run_id\": \"<string>\",\n  \"overview\": {},\n  \"hardware\": {},\n  \"packages\": \"\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/api/ingest/environment")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"run_id\": \"<string>\",\n  \"overview\": {},\n  \"hardware\": {},\n  \"packages\": \"\"\n}"

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

请求头

authorization

string | null

X-StarForge-Token

string | null

请求体

application/json

run_id

string

必填

overview

Overview · object

hardware

Hardware · object

packages

string

默认值:""

响应

Successful Response

开始

接口

Ingest Environment

请求头

请求体

响应