Get by Name

Get the specified Octopus Deploy Connection by name.

GET /api/v1/app-connections/octopus-deploy/connection-name/{connectionName}

cURL

cURL

curl --request GET \
  --url https://us.infisical.com/api/v1/app-connections/octopus-deploy/connection-name/{connectionName}

import requests

url = "https://us.infisical.com/api/v1/app-connections/octopus-deploy/connection-name/{connectionName}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://us.infisical.com/api/v1/app-connections/octopus-deploy/connection-name/{connectionName}', 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/app-connections/octopus-deploy/connection-name/{connectionName}",
  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/app-connections/octopus-deploy/connection-name/{connectionName}"

	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/app-connections/octopus-deploy/connection-name/{connectionName}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.infisical.com/api/v1/app-connections/octopus-deploy/connection-name/{connectionName}")

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

{
  "appConnection": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "app": "octopus-deploy",
    "method": "api-key",
    "credentials": {
      "instanceUrl": "<string>"
    },
    "description": "<string>",
    "version": 1,
    "isPlatformManagedCredentials": false,
    "gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "<string>",
    "isAutoRotationEnabled": false,
    "gatewayPoolId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "rotation": {
      "rotationInterval": 123,
      "rotateAtUtc": {
        "hours": 123,
        "minutes": 123
      },
      "lastRotationMessage": "<string>",
      "nextRotationAt": "2023-11-07T05:31:56Z"
    },
    "credentialsHash": "<string>",
    "project": {
      "name": "<string>",
      "id": "<string>",
      "type": "<string>",
      "slug": "<string>"
    }
  }
}

{
  "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

connectionName · string · required

The name of the Octopus Deploy Connection to retrieve.

Minimum string length: 1

Query Parameters

projectId · string

The project ID of the Octopus Deploy Connection is associated with. Leave unspecified to get organization-level connections.

Response

200

application/json

Default Response

appConnection · Octopus Deploy (API Key) · object · required

Show child attributes