Create Project

Create a new project

POST /api/v1/projects

cURL

cURL

curl --request POST \
  --url https://us.infisical.com/api/v1/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectName": "<string>",
  "projectDescription": "<string>",
  "slug": "<string>",
  "kmsKeyId": "<string>",
  "template": "default",
  "type": "secret-manager",
  "shouldCreateDefaultEnvs": true,
  "hasDeleteProtection": false
}
'

import requests

url = "https://us.infisical.com/api/v1/projects"

payload = {
    "projectName": "<string>",
    "projectDescription": "<string>",
    "slug": "<string>",
    "kmsKeyId": "<string>",
    "template": "default",
    "type": "secret-manager",
    "shouldCreateDefaultEnvs": True,
    "hasDeleteProtection": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    projectName: '<string>',
    projectDescription: '<string>',
    slug: '<string>',
    kmsKeyId: '<string>',
    template: 'default',
    type: 'secret-manager',
    shouldCreateDefaultEnvs: true,
    hasDeleteProtection: false
  })
};

fetch('https://us.infisical.com/api/v1/projects', 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/projects",
  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([
    'projectName' => '<string>',
    'projectDescription' => '<string>',
    'slug' => '<string>',
    'kmsKeyId' => '<string>',
    'template' => 'default',
    'type' => 'secret-manager',
    'shouldCreateDefaultEnvs' => true,
    'hasDeleteProtection' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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/projects"

	payload := strings.NewReader("{\n  \"projectName\": \"<string>\",\n  \"projectDescription\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"kmsKeyId\": \"<string>\",\n  \"template\": \"default\",\n  \"type\": \"secret-manager\",\n  \"shouldCreateDefaultEnvs\": true,\n  \"hasDeleteProtection\": false\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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/projects")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"projectName\": \"<string>\",\n  \"projectDescription\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"kmsKeyId\": \"<string>\",\n  \"template\": \"default\",\n  \"type\": \"secret-manager\",\n  \"shouldCreateDefaultEnvs\": true,\n  \"hasDeleteProtection\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.infisical.com/api/v1/projects")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"projectName\": \"<string>\",\n  \"projectDescription\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"kmsKeyId\": \"<string>\",\n  \"template\": \"default\",\n  \"type\": \"secret-manager\",\n  \"shouldCreateDefaultEnvs\": true,\n  \"hasDeleteProtection\": false\n}"

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

200

{
  "project": {
    "id": "<string>",
    "name": "<string>",
    "type": "<string>",
    "slug": "<string>",
    "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "_id": "<string>",
    "environments": [
      {
        "name": "<string>",
        "slug": "<string>",
        "id": "<string>"
      }
    ],
    "deletedEnvironments": [
      {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "deleteAfter": "2023-11-07T05:31:56Z",
        "softDeletedAt": "2023-11-07T05:31:56Z",
        "deletedBy": {
          "type": "user",
          "id": "<string>",
          "email": "<string>",
          "username": "<string>",
          "firstName": "<string>",
          "lastName": "<string>"
        }
      }
    ],
    "description": "<string>",
    "defaultProduct": "<string>",
    "autoCapitalization": false,
    "version": 1,
    "upgradeStatus": "<string>",
    "pitVersionLimit": 10,
    "kmsCertificateKeyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "auditLogsRetentionDays": 123,
    "hasDeleteProtection": false,
    "secretSharing": true,
    "showSnapshotsLegacy": false,
    "secretDetectionIgnoreValues": [
      "<string>"
    ],
    "enforceEncryptedSecretManagerSecretMetadata": 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>"
}

Authorizations

Authorization · string · header · required

An access token in Infisical

Body

application/json

projectName · string · required

The name of the project to create.

Maximum string length: 64

projectDescription · string

An optional description label for the project.

Maximum string length: 1024

slug · string

An optional slug for the project.

Required string length: 5 - 36

kmsKeyId · string

template · string · default: default

The name of the project template, if specified, to apply to this project.

Required string length: 1 - 64

type · enum<string> · default: secret-manager

Available options: secret-manager, cert-manager, kms, ssh, secret-scanning, pam, ai

shouldCreateDefaultEnvs · boolean · default: true

hasDeleteProtection · boolean · default: false

Response

200

application/json

Default Response

project · object · required

Show child attributes