Skip to main content
API docs by Redocly

Fractal Environments (v1)

Download OpenAPI specification:Download

YanchWare: contacts@yanchware.com URL: https://www.yanchware.com/

Fractal Environments description

AzureInitializer

Authenticates a user based on environment and optionally a tenant ID.

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"

The type of environment.

ownerId
required
string <uuid>

The owner's GUID.

shortName
required
string <= 30 characters

The short name of the environment.

tenantId
string <uuid>

Optional tenant ID. If not provided, defaults to "common".

Responses

/environments/{type}/{ownerId}/{shortName}/initializer/azure/initialize

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
header Parameters
X-Azure-SP-Client-ID
string
X-Azure-SP-Client-Secret
string
Request Body schema:
tenantId
string <uuid>
subscriptionId
string <uuid>
region
string or null
object or null

Responses

Request samples

Content type
{
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "region": "string",
  • "tags": {
    }
}

/environments/{type}/{ownerId}/{shortName}/initializer/azure/retry

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters

Responses

/environments/{type}/{ownerId}/{shortName}/initializer/azure/status

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters

Responses

Gets Azure locations for a given subscription, optionally filtered by tenant.

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
tenantId
string <uuid>
subscriptionId
required
string <uuid>

Responses

Response samples

Content type
No sample

Gets Azure locations for a given subscription, optionally filtered by tenant.

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
tenantId
string <uuid>
subscriptionId
required
string <uuid>

Responses

Response samples

Content type
No sample

CiCdProfiles

/environments/{type}/{ownerId}/{shortName}/ci-cd-profiles

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
Request Body schema:
shortName
string or null
displayName
string or null
description
string or null
sshPrivateKeyData
string or null
sshPrivateKeyPassphrase
string or null

Responses

Request samples

Content type
{
  • "shortName": "string",
  • "displayName": "string",
  • "description": "string",
  • "sshPrivateKeyData": "string",
  • "sshPrivateKeyPassphrase": "string"
}

/environments/{type}/{ownerId}/{shortName}/ci-cd-profiles

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters

Responses

/environments/{type}/{ownerId}/{shortName}/ci-cd-profiles/bulk

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
Request Body schema:
Array
shortName
string or null
displayName
string or null
description
string or null
sshPrivateKeyData
string or null
sshPrivateKeyPassphrase
string or null

Responses

Request samples

Content type
[
  • {
    }
]

/environments/{type}/{ownerId}/{shortName}/ci-cd-profiles/{profileShortName}

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
profileShortName
required
string

Responses

/environments/{type}/{ownerId}/{shortName}/ci-cd-profiles/{profileShortName}

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
profileShortName
required
string
Request Body schema:
displayName
string or null
description
string or null
sshPrivateKeyData
string or null
sshPrivateKeyPassphrase
string or null

Responses

Request samples

Content type
{
  • "displayName": "string",
  • "description": "string",
  • "sshPrivateKeyData": "string",
  • "sshPrivateKeyPassphrase": "string"
}

/environments/{type}/{ownerId}/{shortName}/ci-cd-profiles/{profileShortName}

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
profileShortName
required
string

Responses

Environments

/environments/{type}/{ownerId}/{shortName}

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters

Responses

/environments/{type}/{ownerId}/{shortName}

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
Request Body schema:
object (EnvironmentId)
name
string or null
resourceGroups
Array of strings or null unique
object or null

Responses

Request samples

Content type
{
  • "managementEnvironmentId": {
    },
  • "name": "string",
  • "resourceGroups": [
    ],
  • "parameters": {
    }
}

/environments/{type}/{ownerId}/{shortName}

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
Request Body schema:
object (EnvironmentId)
name
string or null
resourceGroups
Array of strings or null unique
object or null
defaultCiCdProfileShortName
string or null

Responses

Request samples

Content type
{
  • "managementEnvironmentId": {
    },
  • "name": "string",
  • "resourceGroups": [
    ],
  • "parameters": {
    },
  • "defaultCiCdProfileShortName": "string"
}

/environments/{type}/{ownerId}/{shortName}

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters

Responses

GcpInitializer

/environments/{type}/{ownerId}/{shortName}/initializer/gcp/initialize

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
header Parameters
X-GCP-Service-Account-Email
string
X-GCP-Service-Account-Credentials
string
Request Body schema:
required
organizationId
string or null
projectId
string or null
region
string or null
object or null

Responses

Request samples

Content type
{
  • "organizationId": "string",
  • "projectId": "string",
  • "region": "string",
  • "tags": {
    }
}

/environments/{type}/{ownerId}/{shortName}/initializer/gcp/retry

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters

Responses

/environments/{type}/{ownerId}/{shortName}/initializer/gcp/status

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters

Responses

Gets Gcp locations for a given project.

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
projectName
required
string
header Parameters
X-GCP-Service-Account-Email
string
X-GCP-Service-Account-Credentials
string

Responses

Response samples

Content type
No sample

Health

/Health

Authorizations:
Bearer

Responses

Secrets

/environments/{type}/{ownerId}/{shortName}/secrets

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
Request Body schema:
shortName
string or null
displayName
string or null
description
string or null
value
string or null

Responses

Request samples

Content type
{
  • "shortName": "string",
  • "displayName": "string",
  • "description": "string",
  • "value": "string"
}

/environments/{type}/{ownerId}/{shortName}/secrets

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters

Responses

/environments/{type}/{ownerId}/{shortName}/secrets/bulk

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
Request Body schema:
Array
shortName
string or null
displayName
string or null
description
string or null
value
string or null

Responses

Request samples

Content type
[
  • {
    }
]

/environments/{type}/{ownerId}/{shortName}/secrets/{secretShortName}

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
secretShortName
required
string

Responses

/environments/{type}/{ownerId}/{shortName}/secrets/{secretShortName}

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
secretShortName
required
string
Request Body schema:
displayName
string or null
description
string or null
value
string or null

Responses

Request samples

Content type
{
  • "displayName": "string",
  • "description": "string",
  • "value": "string"
}

/environments/{type}/{ownerId}/{shortName}/secrets/{secretName}

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
secretName
required
string

Responses

ServiceAccount

/environments/{type}/{ownerId}/{shortName}/service-accounts/{principalId}

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
principalId
required
string
Request Body schema:
serviceAccountRole
string (ServiceAccountRole)
Enum: "CloudAgent" "CiCd" "Custom" "BasicAuthKeyVaultOnly" "Bot"
description
string or null

Responses

Request samples

Content type
{
  • "serviceAccountRole": "CloudAgent",
  • "description": "string"
}

/environments/{type}/{ownerId}/{shortName}/service-accounts/{principalId}

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
principalId
required
string

Responses

/environments/{type}/{ownerId}/{shortName}/service-accounts/{principalId}

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
principalId
required
string
Request Body schema:
description
string or null
active
boolean

Responses

Request samples

Content type
{
  • "description": "string",
  • "active": true
}

/environments/{type}/{ownerId}/{shortName}/service-accounts/{principalId}

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters
principalId
required
string

Responses

/environments/{type}/{ownerId}/{shortName}/service-accounts

Authorizations:
Bearer
path Parameters
type
required
string (EnvironmentType)
Enum: "Unknown" "Personal" "Organizational"
ownerId
required
string <uuid>
shortName
required
string <= 30 characters

Responses