Create repository

curl --request POST \
  --url https://us.console.entire.io/api/v1/repos \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "clusterHost": "<string>",
  "mirrorClusterSlugs": [
    "<string>"
  ],
  "projectId": "<string>"
}
'

import requests

url = "https://us.console.entire.io/api/v1/repos"

payload = {
    "name": "<string>",
    "clusterHost": "<string>",
    "mirrorClusterSlugs": ["<string>"],
    "projectId": "<string>"
}
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({
    name: '<string>',
    clusterHost: '<string>',
    mirrorClusterSlugs: ['<string>'],
    projectId: '<string>'
  })
};

fetch('https://us.console.entire.io/api/v1/repos', 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.console.entire.io/api/v1/repos",
  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([
    'name' => '<string>',
    'clusterHost' => '<string>',
    'mirrorClusterSlugs' => [
        '<string>'
    ],
    'projectId' => '<string>'
  ]),
  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.console.entire.io/api/v1/repos"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"clusterHost\": \"<string>\",\n  \"mirrorClusterSlugs\": [\n    \"<string>\"\n  ],\n  \"projectId\": \"<string>\"\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.console.entire.io/api/v1/repos")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"clusterHost\": \"<string>\",\n  \"mirrorClusterSlugs\": [\n    \"<string>\"\n  ],\n  \"projectId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.console.entire.io/api/v1/repos")

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  \"name\": \"<string>\",\n  \"clusterHost\": \"<string>\",\n  \"mirrorClusterSlugs\": [\n    \"<string>\"\n  ],\n  \"projectId\": \"<string>\"\n}"

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

{
  "capabilities": {
    "canManage": true,
    "canPull": true,
    "canPush": true
  },
  "id": "<string>",
  "name": "<string>",
  "owningProjectId": "<string>",
  "provider": "github",
  "$schema": "/api/v1/schemas/CreatedRepo.json",
  "candidate": {
    "access": "read",
    "onboardable": true
  },
  "clusterHost": "<string>",
  "clusterSlug": "<string>",
  "commitToken": "<string>",
  "detachedAt": "2023-11-07T05:31:56Z",
  "foreign": true,
  "fullName": "<string>",
  "jurisdiction": "<string>",
  "lastPushedAt": "2023-11-07T05:31:56Z",
  "mirrorClusterSlugs": [
    "<string>"
  ],
  "mirrorSuspended": true,
  "mirrorSuspendedAt": "<string>",
  "nativeMirrors": [
    {
      "attempts": 123,
      "clusterSlug": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "desiredState": "active",
      "placementId": "<string>",
      "stage": "pending",
      "status": "processing",
      "$schema": "/api/v1/schemas/NativeMirrorPlacement.json",
      "creationFailedAt": "2023-11-07T05:31:56Z",
      "failureCode": "<string>",
      "failureMessage": "<string>",
      "lastError": "<string>",
      "nextRetryAt": "2023-11-07T05:31:56Z"
    }
  ],
  "objectFormat": "sha1",
  "path": "<string>",
  "placements": [
    {
      "cell": "<string>",
      "clusterSlug": "<string>",
      "id": "<string>",
      "jurisdiction": "<string>",
      "mirror": true,
      "status": "processing",
      "apiBaseUrl": "<string>"
    }
  ],
  "primaries": {
    "data_primary": {
      "forge": "<string>",
      "repo_id": "<string>"
    },
    "git_data": "<string>",
    "processing": "<string>",
    "processing_primary": {
      "forge": "<string>",
      "repo_id": "<string>"
    }
  },
  "provisionAttempts": 123,
  "provisionReason": "<string>",
  "repoGroupId": "<string>",
  "repositoryId": "<string>",
  "state": "provisioning",
  "visibility": "public"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Repositories

Create repository

An account needs create permission on the project. A plugin installation’s access token needs repositories:create; the repository then goes in the installation’s project and joins the installation, and the response comes after the installation can mint tokens for it. An installation token cannot set clusterHost or mirrorClusterSlugs. An installation creates at most its plugin’s daily limit of repositories in a rolling 24 hours (100 by default); past it the create answers 429 with Retry-After.

POST

repos

Create repository

curl --request POST \
  --url https://us.console.entire.io/api/v1/repos \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "clusterHost": "<string>",
  "mirrorClusterSlugs": [
    "<string>"
  ],
  "projectId": "<string>"
}
'

import requests

url = "https://us.console.entire.io/api/v1/repos"

payload = {
    "name": "<string>",
    "clusterHost": "<string>",
    "mirrorClusterSlugs": ["<string>"],
    "projectId": "<string>"
}
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({
    name: '<string>',
    clusterHost: '<string>',
    mirrorClusterSlugs: ['<string>'],
    projectId: '<string>'
  })
};

fetch('https://us.console.entire.io/api/v1/repos', 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.console.entire.io/api/v1/repos",
  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([
    'name' => '<string>',
    'clusterHost' => '<string>',
    'mirrorClusterSlugs' => [
        '<string>'
    ],
    'projectId' => '<string>'
  ]),
  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.console.entire.io/api/v1/repos"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"clusterHost\": \"<string>\",\n  \"mirrorClusterSlugs\": [\n    \"<string>\"\n  ],\n  \"projectId\": \"<string>\"\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.console.entire.io/api/v1/repos")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"clusterHost\": \"<string>\",\n  \"mirrorClusterSlugs\": [\n    \"<string>\"\n  ],\n  \"projectId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.console.entire.io/api/v1/repos")

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  \"name\": \"<string>\",\n  \"clusterHost\": \"<string>\",\n  \"mirrorClusterSlugs\": [\n    \"<string>\"\n  ],\n  \"projectId\": \"<string>\"\n}"

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

{
  "capabilities": {
    "canManage": true,
    "canPull": true,
    "canPush": true
  },
  "id": "<string>",
  "name": "<string>",
  "owningProjectId": "<string>",
  "provider": "github",
  "$schema": "/api/v1/schemas/CreatedRepo.json",
  "candidate": {
    "access": "read",
    "onboardable": true
  },
  "clusterHost": "<string>",
  "clusterSlug": "<string>",
  "commitToken": "<string>",
  "detachedAt": "2023-11-07T05:31:56Z",
  "foreign": true,
  "fullName": "<string>",
  "jurisdiction": "<string>",
  "lastPushedAt": "2023-11-07T05:31:56Z",
  "mirrorClusterSlugs": [
    "<string>"
  ],
  "mirrorSuspended": true,
  "mirrorSuspendedAt": "<string>",
  "nativeMirrors": [
    {
      "attempts": 123,
      "clusterSlug": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "desiredState": "active",
      "placementId": "<string>",
      "stage": "pending",
      "status": "processing",
      "$schema": "/api/v1/schemas/NativeMirrorPlacement.json",
      "creationFailedAt": "2023-11-07T05:31:56Z",
      "failureCode": "<string>",
      "failureMessage": "<string>",
      "lastError": "<string>",
      "nextRetryAt": "2023-11-07T05:31:56Z"
    }
  ],
  "objectFormat": "sha1",
  "path": "<string>",
  "placements": [
    {
      "cell": "<string>",
      "clusterSlug": "<string>",
      "id": "<string>",
      "jurisdiction": "<string>",
      "mirror": true,
      "status": "processing",
      "apiBaseUrl": "<string>"
    }
  ],
  "primaries": {
    "data_primary": {
      "forge": "<string>",
      "repo_id": "<string>"
    },
    "git_data": "<string>",
    "processing": "<string>",
    "processing_primary": {
      "forge": "<string>",
      "repo_id": "<string>"
    }
  },
  "provisionAttempts": 123,
  "provisionReason": "<string>",
  "repoGroupId": "<string>",
  "repositoryId": "<string>",
  "state": "provisioning",
  "visibility": "public"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

This endpoint is experimental. Its request and response formats may change.

Authorizations

Authorization

string

header

required

Authorization code flow with PKCE-S256. RFC 8628 device flow is also supported.

Body

application/json

name

string

required

Minimum string length: 1

clusterHost

string

Public host of the cluster to pin the repo to (e.g. royalcanin.partial.to); must be in the project's processing cell. Empty takes that cell's cluster.

mirrorClusterSlugs

string[]

Clusters to add native mirrors on once the repo is active. Core stores them with the create and retries each until its mirror exists.

Maximum array length: 16

objectFormat

enum<string>

Hash format; defaults to sha1.

Available options:

sha1,

sha256

projectId

string

Project to create the repo in. Required for an account. A plugin installation's token may omit it; the repo then goes in the installation's project, and any other project answers 404.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

Created

capabilities

object

required

Show child attributes

string

required

name

string

required

owningProjectId

string

required

provider

enum<string>

required

Available options:

github,

entire

$schema

string<uri>

read-only

A URL to the JSON Schema for this object.

Example:

"/api/v1/schemas/CreatedRepo.json"

candidate

object

Show child attributes

clusterHost

string

clusterSlug

string

commitToken

string

deprecated

Deprecated: read the X-Entire-Commit-Token response header instead.

detachedAt

string<date-time>

foreign

boolean

fullName

string

jurisdiction

string

lastPushedAt

string<date-time>

mirrorClusterSlugs

string[]

Native-mirror clusters core stored with this create. Their status is on GET /repos/{repoId}/native-mirrors.

mirrorSuspended

boolean

mirrorSuspendedAt

string

nativeMirrors

object[]

Native mirrors this create queued, each pending with its reserved placementId. Their status is on GET /repos/{repoId}/native-mirrors.

Show child attributes

objectFormat

enum<string>

Available options:

sha1,

sha256

path

string

placements

object[]

Show child attributes

primaries

object

Show child attributes

provisionAttempts

integer<int64>

provisionReason

string

repoGroupId

string

repositoryId

string

Public repository id (repo_ followed by a ULID). Plugin installation routes, access tokens and webhooks use it.

state

enum<string>

Provisioning lifecycle. A mirror is active from creation, before its initial clone completes. A native primary reports deleting while a cascade delete removes its native mirrors; poll until 404.

Available options:

provisioning,

active,

failed,

deleting

visibility

enum<string>

Available options:

public,

private

Documentation

Accounts and projects

Git

Trails

Sessions and checkpoints

Webhooks

Create repository

Authorizations

Body

Response