Create

Create a CircleCI Connection.

POST /api/v1/app-connections/circleci

cURL

cURL

curl --request POST \
  --url https://us.infisical.com/api/v1/app-connections/circleci \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "api-token",
  "credentials": {
    "apiToken": "<string>",
    "host": "<string>"
  },
  "name": "<string>",
  "description": "<string>",
  "projectId": "<string>",
  "isPlatformManagedCredentials": false,
  "gatewayId": "<unknown>",
  "gatewayPoolId": "<unknown>",
  "isAutoRotationEnabled": false,
  "rotation": "<unknown>"
}
'

import requests

url = "https://us.infisical.com/api/v1/app-connections/circleci"

payload = {
    "method": "api-token",
    "credentials": {
        "apiToken": "<string>",
        "host": "<string>"
    },
    "name": "<string>",
    "description": "<string>",
    "projectId": "<string>",
    "isPlatformManagedCredentials": False,
    "gatewayId": "<unknown>",
    "gatewayPoolId": "<unknown>",
    "isAutoRotationEnabled": False,
    "rotation": "<unknown>"
}
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({
    method: 'api-token',
    credentials: {apiToken: '<string>', host: '<string>'},
    name: '<string>',
    description: '<string>',
    projectId: '<string>',
    isPlatformManagedCredentials: false,
    gatewayId: '<unknown>',
    gatewayPoolId: '<unknown>',
    isAutoRotationEnabled: false,
    rotation: '<unknown>'
  })
};

fetch('https://us.infisical.com/api/v1/app-connections/circleci', 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/circleci",
  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([
    'method' => 'api-token',
    'credentials' => [
        'apiToken' => '<string>',
        'host' => '<string>'
    ],
    'name' => '<string>',
    'description' => '<string>',
    'projectId' => '<string>',
    'isPlatformManagedCredentials' => false,
    'gatewayId' => '<unknown>',
    'gatewayPoolId' => '<unknown>',
    'isAutoRotationEnabled' => false,
    'rotation' => '<unknown>'
  ]),
  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/app-connections/circleci"

	payload := strings.NewReader("{\n  \"method\": \"api-token\",\n  \"credentials\": {\n    \"apiToken\": \"<string>\",\n    \"host\": \"<string>\"\n  },\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"isPlatformManagedCredentials\": false,\n  \"gatewayId\": \"<unknown>\",\n  \"gatewayPoolId\": \"<unknown>\",\n  \"isAutoRotationEnabled\": false,\n  \"rotation\": \"<unknown>\"\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/app-connections/circleci")
  .header("Content-Type", "application/json")
  .body("{\n  \"method\": \"api-token\",\n  \"credentials\": {\n    \"apiToken\": \"<string>\",\n    \"host\": \"<string>\"\n  },\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"isPlatformManagedCredentials\": false,\n  \"gatewayId\": \"<unknown>\",\n  \"gatewayPoolId\": \"<unknown>\",\n  \"isAutoRotationEnabled\": false,\n  \"rotation\": \"<unknown>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.infisical.com/api/v1/app-connections/circleci")

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  \"method\": \"api-token\",\n  \"credentials\": {\n    \"apiToken\": \"<string>\",\n    \"host\": \"<string>\"\n  },\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"isPlatformManagedCredentials\": false,\n  \"gatewayId\": \"<unknown>\",\n  \"gatewayPoolId\": \"<unknown>\",\n  \"isAutoRotationEnabled\": false,\n  \"rotation\": \"<unknown>\"\n}"

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": "circleci",
    "method": "api-token",
    "credentials": {
      "host": "<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>"
}

Check out the configuration docs for CircleCI Connections to learn how to obtain the required credentials.

Body

application/json

method · enum<string> · required

The method used to authenticate with CircleCI.

Available options: api-token

credentials · object · required

The credentials used to connect with CircleCI.

Show child attributes

name · string · required

The name of the CircleCI Connection to create. Must be slug-friendly.

Required string length: 1 - 64

description · string | null

An optional description for the CircleCI Connection.

Maximum string length: 256

projectId · string

The ID of the project to create the CircleCI Connection in.

isPlatformManagedCredentials · enum<boolean>

Not supported for CircleCI Connections.

Available options: false

gatewayId · any enum<string>

Not supported for CircleCI Connections.

gatewayPoolId · any enum<string>

Not supported for CircleCI Connections.

isAutoRotationEnabled · enum<boolean>

Not supported for CircleCI Connections.

Available options: false

rotation · any enum<string>

Not supported for CircleCI Connections.

Response

200

application/json

Default Response

appConnection · CircleCI (Personal Access Token) · object · required

Show child attributes