Create

Create a proxied service

POST /api/v1/proxied-services

cURL

cURL

curl --request POST \
  --url https://us.infisical.com/api/v1/proxied-services \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "<string>",
  "environment": "<string>",
  "name": "<string>",
  "hostPattern": "<string>",
  "credentials": [
    {
      "secretKey": "<string>",
      "dynamicSecretName": "<string>",
      "dynamicSecretField": "<string>",
      "headerName": "<string>",
      "headerPrefix": "<string>",
      "placeholderKey": "<string>",
      "placeholderValue": "<string>",
      "substitutionSurfaces": []
    }
  ],
  "secretPath": "/",
  "isEnabled": true
}
'

import requests

url = "https://us.infisical.com/api/v1/proxied-services"

payload = {
    "projectId": "<string>",
    "environment": "<string>",
    "name": "<string>",
    "hostPattern": "<string>",
    "credentials": [
        {
            "secretKey": "<string>",
            "dynamicSecretName": "<string>",
            "dynamicSecretField": "<string>",
            "headerName": "<string>",
            "headerPrefix": "<string>",
            "placeholderKey": "<string>",
            "placeholderValue": "<string>",
            "substitutionSurfaces": []
        }
    ],
    "secretPath": "/",
    "isEnabled": True
}
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({
    projectId: '<string>',
    environment: '<string>',
    name: '<string>',
    hostPattern: '<string>',
    credentials: [
      {
        secretKey: '<string>',
        dynamicSecretName: '<string>',
        dynamicSecretField: '<string>',
        headerName: '<string>',
        headerPrefix: '<string>',
        placeholderKey: '<string>',
        placeholderValue: '<string>',
        substitutionSurfaces: []
      }
    ],
    secretPath: '/',
    isEnabled: true
  })
};

fetch('https://us.infisical.com/api/v1/proxied-services', 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://us.infisical.com/api/v1/proxied-services",
  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([
    'projectId' => '<string>',
    'environment' => '<string>',
    'name' => '<string>',
    'hostPattern' => '<string>',
    'credentials' => [
        [
                'secretKey' => '<string>',
                'dynamicSecretName' => '<string>',
                'dynamicSecretField' => '<string>',
                'headerName' => '<string>',
                'headerPrefix' => '<string>',
                'placeholderKey' => '<string>',
                'placeholderValue' => '<string>',
                'substitutionSurfaces' => [
                                
                ]
        ]
    ],
    'secretPath' => '/',
    'isEnabled' => true
  ]),
  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://us.infisical.com/api/v1/proxied-services"

	payload := strings.NewReader("{\n  \"projectId\": \"<string>\",\n  \"environment\": \"<string>\",\n  \"name\": \"<string>\",\n  \"hostPattern\": \"<string>\",\n  \"credentials\": [\n    {\n      \"secretKey\": \"<string>\",\n      \"dynamicSecretName\": \"<string>\",\n      \"dynamicSecretField\": \"<string>\",\n      \"headerName\": \"<string>\",\n      \"headerPrefix\": \"<string>\",\n      \"placeholderKey\": \"<string>\",\n      \"placeholderValue\": \"<string>\",\n      \"substitutionSurfaces\": []\n    }\n  ],\n  \"secretPath\": \"/\",\n  \"isEnabled\": true\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://us.infisical.com/api/v1/proxied-services")
  .header("Content-Type", "application/json")
  .body("{\n  \"projectId\": \"<string>\",\n  \"environment\": \"<string>\",\n  \"name\": \"<string>\",\n  \"hostPattern\": \"<string>\",\n  \"credentials\": [\n    {\n      \"secretKey\": \"<string>\",\n      \"dynamicSecretName\": \"<string>\",\n      \"dynamicSecretField\": \"<string>\",\n      \"headerName\": \"<string>\",\n      \"headerPrefix\": \"<string>\",\n      \"placeholderKey\": \"<string>\",\n      \"placeholderValue\": \"<string>\",\n      \"substitutionSurfaces\": []\n    }\n  ],\n  \"secretPath\": \"/\",\n  \"isEnabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.infisical.com/api/v1/proxied-services")

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  \"projectId\": \"<string>\",\n  \"environment\": \"<string>\",\n  \"name\": \"<string>\",\n  \"hostPattern\": \"<string>\",\n  \"credentials\": [\n    {\n      \"secretKey\": \"<string>\",\n      \"dynamicSecretName\": \"<string>\",\n      \"dynamicSecretField\": \"<string>\",\n      \"headerName\": \"<string>\",\n      \"headerPrefix\": \"<string>\",\n      \"placeholderKey\": \"<string>\",\n      \"placeholderValue\": \"<string>\",\n      \"substitutionSurfaces\": []\n    }\n  ],\n  \"secretPath\": \"/\",\n  \"isEnabled\": true\n}"

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

200

{
  "service": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "hostPattern": "<string>",
    "folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "credentials": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "role": "<string>",
        "secretKey": "<string>",
        "headerName": "<string>",
        "headerPrefix": "<string>",
        "headerPurpose": "<string>",
        "placeholderKey": "<string>",
        "placeholderValue": "<string>",
        "substitutionSurfaces": [
          "<string>"
        ],
        "dynamicSecretName": "<string>",
        "dynamicSecretField": "<string>"
      }
    ],
    "isEnabled": true
  }
}

{
  "reqId": "<string>",
  "statusCode": 400,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 401,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 403,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 404,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 422,
  "error": "<string>",
  "message": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 500,
  "message": "<string>",
  "error": "<string>"
}

Body

application/json

projectId · string · required

The ID of the project to create the proxied service in.

Minimum string length: 1

environment · string · required

The slug of the environment to create the proxied service in.

Minimum string length: 1

name · string · required

The name of the proxied service.

Required string length: 1 - 64

hostPattern · string · required

One or more comma-separated host patterns the service applies to, e.g. 'api.stripe.com, .stripe.com'. Each pattern is host[:port][/path]; a '.' wildcard matches exactly one label.

Required string length: 1 - 255

credentials · object[] · required

The credentials the agent proxy applies to requests matching the host pattern.

Minimum array length: 1

Show child attributes

secretPath · string · default: /

The secret path (folder) to create the proxied service in.

isEnabled · boolean

Whether the proxied service is enabled. The agent proxy skips disabled services.

Response

200

application/json

Default Response

service · object · required

Show child attributes