Environments

The Environments service owns Environment data in the Fractal Cloud application.

• AwsInitializer
  • postStart AWS authentication via IAM Identity Center (SSO) or direct credentials.
  • post/environments/{type}/{ownerId}/{shortName}/initializer/aws/initialize
  • get/environments/{type}/{ownerId}/{shortName}/initializer/aws/status
  • postRetrieves AWS regions accessible for the selected account.
  • getGets AWS regions for a given project.
• AzureInitializer
  • postAuthenticates a user based on environment and optionally a tenant ID.
  • post/environments/{type}/{ownerId}/{shortName}/initializer/azure/initialize
  • post/environments/{type}/{ownerId}/{shortName}/initializer/azure/retry
  • get/environments/{type}/{ownerId}/{shortName}/initializer/azure/status
  • getGets Azure locations for a given subscription, optionally filtered by tenant.
  • getGets Azure locations for a given subscription, optionally filtered by tenant.
• CiCdProfiles
  • post/environments/{type}/{ownerId}/{shortName}/ci-cd-profiles
  • get/environments/{type}/{ownerId}/{shortName}/ci-cd-profiles
  • post/environments/{type}/{ownerId}/{shortName}/ci-cd-profiles/bulk
  • get/environments/{type}/{ownerId}/{shortName}/ci-cd-profiles/{profileShortName}
  • put/environments/{type}/{ownerId}/{shortName}/ci-cd-profiles/{profileShortName}
  • del/environments/{type}/{ownerId}/{shortName}/ci-cd-profiles/{profileShortName}
• Environments
  • get/environments/{type}/{ownerId}/{shortName}
  • post/environments/{type}/{ownerId}/{shortName}
  • put/environments/{type}/{ownerId}/{shortName}
  • del/environments/{type}/{ownerId}/{shortName}
• GcpInitializer
  • post/environments/{type}/{ownerId}/{shortName}/initializer/gcp/oauth/authorize
  • post/environments/gcp/oauth/callback
  • post/environments/{type}/{ownerId}/{shortName}/initializer/gcp/initialize
  • post/environments/{type}/{ownerId}/{shortName}/initializer/gcp/retry
  • get/environments/{type}/{ownerId}/{shortName}/initializer/gcp/status
  • postRetrieves GCP regions accessible for the selected project.
  • getGets Gcp locations for a given project.
• Health
  • get/Health
• HetznerInitializer
  • post/environments/{type}/{ownerId}/{shortName}/initializer/hetzner/initialize
  • get/environments/{type}/{ownerId}/{shortName}/initializer/hetzner/status
• Secrets
  • post/environments/{type}/{ownerId}/{shortName}/secrets
  • get/environments/{type}/{ownerId}/{shortName}/secrets
  • post/environments/{type}/{ownerId}/{shortName}/secrets/bulk
  • get/environments/{type}/{ownerId}/{shortName}/secrets/{secretShortName}
  • put/environments/{type}/{ownerId}/{shortName}/secrets/{secretShortName}
  • del/environments/{type}/{ownerId}/{shortName}/secrets/{secretName}
• ServiceAccount
  • post/environments/{type}/{ownerId}/{shortName}/service-accounts/{principalId}
  • get/environments/{type}/{ownerId}/{shortName}/service-accounts/{principalId}
  • put/environments/{type}/{ownerId}/{shortName}/service-accounts/{principalId}
  • del/environments/{type}/{ownerId}/{shortName}/service-accounts/{principalId}
  • get/environments/{type}/{ownerId}/{shortName}/service-accounts

API docs by Redocly

Fractal Environments (v1)

Download OpenAPI specification:Download

Fractal Cloud: contact-us@fractal.cloud URL: https://fractal.cloud/

Fractal Environments description

AwsInitializer

Start AWS authentication via IAM Identity Center (SSO) or direct credentials.

• SSO (Device Authorization Flow): Returns 202 Accepted and publishes a device code event.
• Direct IAM credentials: Can be queued immediately.

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

ssoRegion	string or null AWS IAM Identity Center (SSO) region used for the OIDC device authorization flow (e.g., 'eu-central-1'). Required if using SSO flow.
ssoStartUrl	string or null AWS SSO start URL for the account or organization. Example formats: Default: https://d-xxxxxxxxxx.awsapps.com/start Custom subdomain: https://your_subdomain.awsapps.com/start Required if using SSO flow.
accessKeyId	string or null AWS IAM access key ID. Required if using direct credentials.
secretAccessKey	string or null AWS IAM secret access key. Required if using direct credentials.
sessionToken	string or null AWS IAM session token. Required if using direct credentials.

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/initializer/aws/authenticate

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "ssoRegion": null,
• "ssoStartUrl": null,
• "accessKeyId": "AKIAxxxxxxxxxxxx",
• "secretAccessKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
• "sessionToken": "FQoGZXIvYXdzEFQaDm/..."

}

Response samples

• 202

Content type

application/json

{

• "messageType": "Unknown",
• "messageName": "string",
• "version": "string",
• "authorizations": "string",
• "eventName": "string",
• "environmentId": {

  • "type": "Unknown",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "shortName": "string"

  },
• "deviceCodeResult": {

  • "userCode": "string",
  • "verificationUri": "string",
  • "expiresOn": "2019-08-24T14:15:22Z",
  • "message": "string"

  }

}

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

header Parameters

X-AWS-Access-Key-ID	string
X-AWS-Secret-Access-Key	string
X-AWS-Session-Token	string

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

accountId	string or null
region	string or null
organizationId	string or null
	object or null

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/initializer/aws/initialize

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "accountId": "string",
• "region": "string",
• "organizationId": "string",
• "tags": {

  • "property1": "string",
  • "property2": "string"

  }

}

Response samples

• 202
• 400
• 401

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "environmentId": {

  • "type": "Unknown",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "shortName": "string"

  },
• "cloudProvider": "Unknown",
• "steps": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "string",
    • "description": "string",
    • "order": 0,
    • "resourceName": "string",
    • "resourceType": "string",
    • "outputFields": {

      • "property1": null,
      • "property2": null

      },
    • "lastOperationStatusMessage": "string",
    • "status": "Unknown",
    • "retryCount": 0,
    • "createdAt": "2019-08-24T14:15:22Z",
    • "updatedAt": "2019-08-24T14:15:22Z"

    }

  ],
• "status": "Unknown",
• "requester": "string",
• "createdAt": "2019-08-24T14:15:22Z"

}

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/initializer/aws/status

Retrieves AWS regions accessible for the selected account.

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

header Parameters

X-AWS-Access-Key-ID	string
X-AWS-Secret-Access-Key	string
X-AWS-Session-Token	string

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

accountId	string or null
organizationId	string or null
roleName	string or null
ssoRegion	string or null

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/initializer/aws/selected/account

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "accountId": "string",
• "organizationId": "string",
• "roleName": "string",
• "ssoRegion": "string"

}

Response samples

• 200

Content type

application/json

[

• {

  • "provider": "Unknown",
  • "locationId": "string",
  • "displayName": "string",
  • "latitude": 0.1,
  • "longitude": 0.1

  }

]

Gets AWS regions for a given project.

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

header Parameters

X-AWS-Access-Key-ID	string
X-AWS-Secret-Access-Key	string
X-AWS-Session-Token	string

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/initializer/aws/regions

Response samples

• 200

Content type

application/json

[

• {

  • "name": "string",
  • "endpoint": "string",
  • "optInStatus": "string",
  • "latitude": 0.1,
  • "longitude": 0.1

  }

]

AzureInitializer

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.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

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/initializer/azure/authenticate/{tenantId}

Response samples

• 400
• 401

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.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:

application/jsontext/jsonapplication/*+jsonapplication/json

tenantId	string <uuid>
subscriptionId	string <uuid>
region	string or null
	object or null

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/initializer/azure/initialize

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

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

  • "property1": "string",
  • "property2": "string"

  }

}

Response samples

• 202
• 400
• 401

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "environmentId": {

  • "type": "Unknown",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "shortName": "string"

  },
• "cloudProvider": "Unknown",
• "steps": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "string",
    • "description": "string",
    • "order": 0,
    • "resourceName": "string",
    • "resourceType": "string",
    • "outputFields": {

      • "property1": null,
      • "property2": null

      },
    • "lastOperationStatusMessage": "string",
    • "status": "Unknown",
    • "retryCount": 0,
    • "createdAt": "2019-08-24T14:15:22Z",
    • "updatedAt": "2019-08-24T14:15:22Z"

    }

  ],
• "status": "Unknown",
• "requester": "string",
• "createdAt": "2019-08-24T14:15:22Z"

}

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/initializer/azure/retry

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/initializer/azure/status

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters
tenantId	string <uuid>
subscriptionId required	string <uuid>

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/initializer/azure/{tenantId}/subscriptions/{subscriptionId}/locations

Response samples

• 200

Content type

application/json

[

• {

  • "id": "string",
  • "name": "string",
  • "displayName": "string",
  • "regionalDisplayName": "string",
  • "type": "string",
  • "metadata": {

    • "regionType": "string",
    • "regionCategory": "string",
    • "geographyGroup": "string",
    • "longitude": "string",
    • "latitude": "string",
    • "physicalLocation": "string",
    • "pairedRegions": [

      • {

        • "name": "string",
        • "id": "string"

        }

      ],
    • "homeLocation": "string"

    },
  • "availabilityZoneMappings": [

    • {

      • "logicalZone": "string",
      • "physicalZone": "string"

      }

    ]

  }

]

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters
tenantId	string <uuid>
subscriptionId required	string <uuid>

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/initializer/azure/subscriptions/{subscriptionId}/locations

Response samples

• 200

Content type

application/json

[

• {

  • "id": "string",
  • "name": "string",
  • "displayName": "string",
  • "regionalDisplayName": "string",
  • "type": "string",
  • "metadata": {

    • "regionType": "string",
    • "regionCategory": "string",
    • "geographyGroup": "string",
    • "longitude": "string",
    • "latitude": "string",
    • "physicalLocation": "string",
    • "pairedRegions": [

      • {

        • "name": "string",
        • "id": "string"

        }

      ],
    • "homeLocation": "string"

    },
  • "availabilityZoneMappings": [

    • {

      • "logicalZone": "string",
      • "physicalZone": "string"

      }

    ]

  }

]

CiCdProfiles

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

shortName	string or null
displayName	string or null
description	string or null
sshPrivateKeyData	string or null
sshPrivateKeyPassphrase	string or null

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/ci-cd-profiles

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "shortName": "string",
• "displayName": "string",
• "description": "string",
• "sshPrivateKeyData": "string",
• "sshPrivateKeyPassphrase": "string"

}

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/ci-cd-profiles

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Array

shortName	string or null
displayName	string or null
description	string or null
sshPrivateKeyData	string or null
sshPrivateKeyPassphrase	string or null

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/ci-cd-profiles/bulk

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

[

• {

  • "shortName": "string",
  • "displayName": "string",
  • "description": "string",
  • "sshPrivateKeyData": "string",
  • "sshPrivateKeyPassphrase": "string"

  }

]

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters
profileShortName required	string

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/ci-cd-profiles/{profileShortName}

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters
profileShortName required	string

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

displayName	string or null
description	string or null
sshPrivateKeyData	string or null
sshPrivateKeyPassphrase	string or null

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/ci-cd-profiles/{profileShortName}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "displayName": "string",
• "description": "string",
• "sshPrivateKeyData": "string",
• "sshPrivateKeyPassphrase": "string"

}

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters
profileShortName required	string

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/ci-cd-profiles/{profileShortName}

Environments

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}

Response samples

• 200
• 400
• 401
• 404

Content type

application/json

{

• "managementEnvironmentId": {

  • "type": "Unknown",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "shortName": "string"

  },
• "id": {

  • "type": "Unknown",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "shortName": "string"

  },
• "name": "string",
• "resourceGroups": [

  • "string"

  ],
• "parameters": {

  • "property1": null,
  • "property2": null

  },
• "defaultCiCdProfileShortName": "string",
• "status": "Unknown",
• "createdAt": "2019-08-24T14:15:22Z",
• "createdBy": "string",
• "updatedAt": "2019-08-24T14:15:22Z",
• "updatedBy": "string"

}

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

	object (YanchWare.Fractal.Environments.Domain.Values.EnvironmentId)
name	string or null
resourceGroups	Array of strings or null unique
	object or null

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "managementEnvironmentId": {

  • "type": "Unknown",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "shortName": "string"

  },
• "name": "string",
• "resourceGroups": [

  • "string"

  ],
• "parameters": {

  • "property1": null,
  • "property2": null

  }

}

Response samples

• 201
• 400
• 401

Content type

application/json

{

• "managementEnvironmentId": {

  • "type": "Unknown",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "shortName": "string"

  },
• "id": {

  • "type": "Unknown",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "shortName": "string"

  },
• "name": "string",
• "resourceGroups": [

  • "string"

  ],
• "parameters": {

  • "property1": null,
  • "property2": null

  },
• "defaultCiCdProfileShortName": "string",
• "status": "Unknown",
• "createdAt": "2019-08-24T14:15:22Z",
• "createdBy": "string",
• "updatedAt": "2019-08-24T14:15:22Z",
• "updatedBy": "string"

}

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

	object (YanchWare.Fractal.Environments.Domain.Values.EnvironmentId)
name	string or null
resourceGroups	Array of strings or null unique
	object or null
defaultCiCdProfileShortName	string or null

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "managementEnvironmentId": {

  • "type": "Unknown",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "shortName": "string"

  },
• "name": "string",
• "resourceGroups": [

  • "string"

  ],
• "parameters": {

  • "property1": null,
  • "property2": null

  },
• "defaultCiCdProfileShortName": "string"

}

Response samples

• 200
• 400
• 401

Content type

application/json

{

• "managementEnvironmentId": {

  • "type": "Unknown",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "shortName": "string"

  },
• "id": {

  • "type": "Unknown",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "shortName": "string"

  },
• "name": "string",
• "resourceGroups": [

  • "string"

  ],
• "parameters": {

  • "property1": null,
  • "property2": null

  },
• "defaultCiCdProfileShortName": "string",
• "status": "Unknown",
• "createdAt": "2019-08-24T14:15:22Z",
• "createdBy": "string",
• "updatedAt": "2019-08-24T14:15:22Z",
• "updatedBy": "string"

}

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}

Response samples

• 400
• 401

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

GcpInitializer

/environments/{type}/{ownerId}/{shortName}/initializer/gcp/oauth/authorize

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/initializer/gcp/oauth/authorize

Response samples

• 400
• 401

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

/environments/gcp/oauth/callback

Authorizations:

Bearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

state	string <uuid>
code	string or null
scope	string or null
error	string or null

Responses

https://docs.fractal.cloud/environments/gcp/oauth/callback

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "state": "0e231ca7-8c83-44ad-9df9-f0699a512c67",
• "code": "string",
• "scope": "string",
• "error": "string"

}

Response samples

• 200

Content type

application/json

{

• "environmentId": {

  • "type": "Unknown",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "shortName": "string"

  },
• "status": "Success",
• "message": "string"

}

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.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:

application/jsontext/jsonapplication/*+jsonapplication/json

required

organizationId	string or null
projectId	string or null
region	string or null
	object or null
fractalConnectorCidr	string or null

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/initializer/gcp/initialize

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "organizationId": "string",
• "projectId": "string",
• "region": "string",
• "tags": {

  • "property1": "string",
  • "property2": "string"

  },
• "fractalConnectorCidr": "string"

}

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/initializer/gcp/retry

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/initializer/gcp/status

Retrieves GCP regions accessible for the selected project.

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.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:

application/jsontext/jsonapplication/*+jsonapplication/json

projectId	string or null
organizationId	string or null

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/initializer/gcp/selected/project

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "projectId": "string",
• "organizationId": "string"

}

Response samples

• 200

Content type

application/json

[

• {

  • "provider": "Unknown",
  • "locationId": "string",
  • "displayName": "string",
  • "latitude": 0.1,
  • "longitude": 0.1

  }

]

Gets Gcp locations for a given project.

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.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

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/initializer/gcp/projects/{projectName}/locations

Response samples

• 200

Content type

application/json

[

• {

  • "id": 0,
  • "name": "string",
  • "kind": "string",
  • "description": "string",
  • "status": "string",
  • "zones": [

    • "string"

    ],
  • "latitude": 0.1,
  • "longitude": 0.1

  }

]

Health

/Health

Authorizations:

Bearer

Responses

https://docs.fractal.cloud/Health

HetznerInitializer

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

header Parameters

X-Hetzner-Token

string

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

projectId	string or null
region	string or null
	object or null

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/initializer/hetzner/initialize

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "projectId": "string",
• "region": "string",
• "tags": {

  • "property1": "string",
  • "property2": "string"

  }

}

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/initializer/hetzner/status

Secrets

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

shortName	string or null
displayName	string or null
description	string or null
value	string or null

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/secrets

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "shortName": "string",
• "displayName": "string",
• "description": "string",
• "value": "string"

}

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/secrets

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Array

shortName	string or null
displayName	string or null
description	string or null
value	string or null

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/secrets/bulk

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

[

• {

  • "shortName": "string",
  • "displayName": "string",
  • "description": "string",
  • "value": "string"

  }

]

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters
secretShortName required	string

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/secrets/{secretShortName}

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters
secretShortName required	string

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

displayName	string or null
description	string or null
value	string or null

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/secrets/{secretShortName}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "displayName": "string",
• "description": "string",
• "value": "string"

}

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters
secretName required	string

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/secrets/{secretName}

ServiceAccount

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters
principalId required	string

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

serviceAccountRole	string (YanchWare.Fractal.Environments.Domain.Enums.ServiceAccountRole) Enum: "CloudAgent" "CiCd" "Custom" "BasicAuthKeyVaultOnly" "Bot"
description	string or null

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/service-accounts/{principalId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "serviceAccountRole": "CloudAgent",
• "description": "string"

}

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters
principalId required	string

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/service-accounts/{principalId}

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters
principalId required	string

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

description	string or null
active	boolean

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/service-accounts/{principalId}

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "description": "string",
• "active": true

}

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters
principalId required	string

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/service-accounts/{principalId}

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

Authorizations:

Bearer

path Parameters

type required	string (YanchWare.Fractal.Environments.Domain.Enums.EnvironmentType) Enum: "Unknown" "Personal" "Organizational"
ownerId required	string <uuid>
shortName required	string <= 30 characters

Responses

https://docs.fractal.cloud/environments/{type}/{ownerId}/{shortName}/service-accounts