Get by Name

Get a proxied service by name

GET /api/v1/proxied-services/slug/{name}

cURL

cURL

curl --request GET \
  --url https://us.infisical.com/api/v1/proxied-services/slug/{name}

import requests

url = "https://us.infisical.com/api/v1/proxied-services/slug/{name}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://us.infisical.com/api/v1/proxied-services/slug/{name}', 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/slug/{name}",
  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://us.infisical.com/api/v1/proxied-services/slug/{name}"

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://us.infisical.com/api/v1/proxied-services/slug/{name}")
  .asString();

require 'uri'
require 'net/http'

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

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

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>",
        "callerCanLease": true
      }
    ],
    "canProxy": true,
    "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>"
}

Path Parameters

name · string · required

The name of the proxied service.

Required string length: 1 - 64

Query Parameters

projectId · string · required

The ID of the project the proxied service is in.

Minimum string length: 1

environment · string · required

The slug of the environment the proxied service is in.

Minimum string length: 1

secretPath · string · default: /

The secret path (folder) the proxied service is in.

Response

200

application/json

Default Response

service · object · required

Show child attributes