Tessell Subscription API
The Subscription API from Tessell — 22 operation(s) for subscription.
Tessell Subscription API is one of 82 APIs that Tessell publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Subscription. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.
This API exposes 26 operations across 22 paths, and defines 97 schemas. It is described by OpenAPI 3.0.3, at version 1.0.
Requests are made against a single base URL, {server}.
26 operations
22 paths
97 schemas
2 DELETE11 GET4 PATCH3 POST6 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Tessell Subscription API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (BearerAuth).
Paths & Operations 26
Across 22 paths, the API surfaces 26 operations — 2 DELETE, 11 GET, 4 PATCH, 3 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.
Subscription 26
GET
/subscriptions
Returns details about the Tessell Subscriptions
POST
/subscription-service/governance/subscriptions
Create a new Tessell subscription.
GET
/subscription-service/governance/subscriptions
Returns details about the Tessell Subscriptions
GET
/subscription-service/governance/subscriptions/{name}
Submits request to get the subscription details
PATCH
/subscription-service/governance/subscriptions/{name}
Submits request to update a Tessell Subscription
DELETE
/subscription-service/governance/subscriptions/{name}
Submits request to delete a Tessell Subscription
PATCH
/subscription-service/governance/subscriptions/{name}/{action}
Submits request to enable or disable a Tessell Subscription
POST
/subscription-service/governance/subscriptions/{name}/cloud-type
Adds cloud type to a new Tessell subscription
PATCH
/subscription-service/governance/subscriptions/{name}/cloud-type/{cloud-type}/{action}
Enables or disables a cloud type in a Tessell Subscription
PUT
/subscription-service/governance/subscriptions/{name}/cloud-type/{cloud-type}/regions
Update regions for a cloud type in a Tessell Subscription
PUT
/subscription-service/governance/subscriptions/{name}/add-regions
Add regions for a cloud type in a Tessell Subscription
PATCH
/subscription-service/governance/subscriptions/{name}/acls
Adds users to a Tessell subscription
DELETE
/subscription-service/governance/subscriptions/{name}/acls
Removes users from a Tessell subscription
GET
/subscription-service/governance/subscriptions/{name}/users
Get subscription's users' details
GET
/subscription-service/governance/subscriptions/{name}/acls/eligible-users
Get users which can be added to the subscription
GET
/subscription-service/governance/subscription-metadata/byoa
Get subscription related metadata
GET
/subscription-service/governance/subscriptions/{name}/track
Track the progress of the ongoing subscription creation operation
GET
/subscription-service/governance/subscriptions/{name}/regions/track
Track the progress of the ongoing region onboarding operation
PUT
/subscription-service/governance/subscriptions/{name}/resubmit
Resubmits failed Tessell Subscription creation
PUT
/subscription-service/governance/subscriptions/{name}/regions/resubmit
Resubmits failed region onboarding
PUT
/subscription-service/governance/subscriptions/{name}/steps/{step-id}/skip
Skip a particular step in the subscription creation flow
PUT
/subscription-service/governance/subscriptions/{name}/regions/steps/{step-id}/skip
Skip a particular step in the region onboarding flow
GET
/subscription-service/generate-register-vm-script
Generate a script to register any compute resource with tessell
POST
/subscription-service/register-vm
Register a compute resource after executing the script
GET
/subscription-service/governance/subscriptions/{name}/resources
Returns the list of user resources under a Tessell Subscription
GET
/subscription-service/governance/subscriptions/{name}/progress
Track the progress of the ongoing subscription deletion operation
Schemas 97
The contract defines 97 schemas that model the data the API accepts and returns. The most detailed are SubscriptionAdminView (11 properties), SubscriptionUserView (9 properties), ApiErrorOps (8 properties), GcpResourceTag (8 properties). Each schema is shown below with its type and property counts.
apiStatus
object
2 properties
GcpPrivateServiceConnect
object
Private Service Connect endpoint information from Terraform output
3 properties
ApiError
object
Common error response object for non 2xx responses
7 properties
SubscriptionByoaStaticMetadata
object
Metadata for BYOA subscription
2 properties
1 required
Progress
object
Progress of the execution
2 properties
EntityAclSharingInfo
object
Tessell Entity ACL Sharing Info
1 property
SubscriptionUserView
object
User view of the subscription
9 properties
GcpSubscriptionInfo
object
Subscription metadata from Terraform output
7 properties
4 required
AwsByoaExecutionOutputSubnet
object
VPC subnet created as part of the cloud formation deployment
1 property
1 required
GcpServiceAccount
object
Service account information from Terraform output
3 properties
3 required
ApiErrorOps
object
Common error response object for non 2xx responses of internal or ops APIs
8 properties
KeyOcid
string
SubscriptionAwsOnboardingConfig
object
AWS onboarding configuration
2 properties
2 required
AwsByoaExecutionOutputStorage
object
Storage level resources created as part of the cloud formationtion deployment
1 property
1 required
UpdateSubscriptionServicePayload
object
Payload for updating subscription
1 property
1 required
SubscriptionAzureConfig
TerraformOutputServiceAccount
object
Terraform output block for serviceaccount
1 property
1 required
AzureByoaExecutionOutputResources
object
Resources created as part of the arm template deployment
8 properties
1 required
DeleteSubscriptionTrackingDetails
object
Execution details of subscription deletion
6 properties
TerraformOutputPrivateServiceConnect
object
Terraform output block for privateserviceconnect
1 property
1 required
SubscriptionByoaAwsStaticMetadata
object
AWS metadata for BYOA
2 properties
2 required
SubscriptionUserRole
string
Subscription user role
SubscriptionsUserViewApiResponse
object
Api response for user view of subscription
2 properties
TerraformOutputSubscriptionInfo
object
Terraform output block for subscriptioninfo
1 property
1 required
SubscriptionUserAdminView
object
6 properties
GcpCryptoKey
object
Cloud KMS crypto key information
2 properties
2 required
AwsByoaExecutionOutputPrivateEndpoints
object
Private endpoint resources created as part of cloud formation deployment
6 properties
1 required
TerraformOutputSecurity
object
Terraform output block for security
1 property
1 required
AwsByoaExecutionOutputResources
object
Resources created as part of the cloud formation deployment
6 properties
TerraformOutputVpc
object
Terraform output block for vpc
1 property
1 required
TenantRegion
object
Region specific details
2 properties
UpdateRegionsPayload
object
Payload for updating regions in the subscription
1 property
1 required
cloudType
string
Tessell supported cloud types
AssociationStatus
string
Cloud account Association Status with the subscription
TerraformOutputStorage
object
Terraform output block for storage
1 property
1 required
EntityUserAclSharingInfo
object
Tessell Entity ACL Sharing Info for a user
4 properties
CompartmentOcid
string
ExadataRegisterVmScript
object
1 property
deboardingInfo
object
2 properties
CreateSubscriptionPayload
object
Payload for subscription creation
5 properties
3 required
SubscriptionOciConfig
SubscriptionUserRoleExtended
string
Subscription user role extended to include owner as well
SubscriptionCloudConfig
object
List of cloud regions
2 properties
1 required
GcpSecureTag
object
GCP secure tag information (reserved for future use)
5 properties
OciByoaExecutionOutputResources
object
Resources registered as part of the terraform deployment
4 properties
4 required
subscriptionDeploymentType
string
Tessell Subscription Deployment Type
AclRevokePayload
object
Payload to revoke Tessell ACLs
1 property
1 required
StepError
object
Step error details
4 properties
CreateSubscriptionTrackingDetails
object
Execution details of subscription creation
5 properties
subscriptionStatus
string
Tessell Subscription Status
apiPaginationInfo
object
2 properties
Action
string
Action on any entity for enabling/disabling
AclPayload
object
Payload to create an entity ACL
1 property
1 required
AzureByoaExecutionOutput
object
Output from the execution done at customer's account either via arm deployment or via script
7 properties
2 required
OciCompartmentInfo
object
1 property
AzureByoaExecutionOutputKeyVault
object
Key Vault level resources created as part of the arm template deployment
1 property
1 required
OciByoaExecutionOutput
object
Output from the execution done at customer's account either via terraform or via script
3 properties
2 required
AclUserPayload
object
Payload to create an user's entity ACL
2 properties
2 required
apiMetadata
object
3 properties
VaultOcid
string
ActivityStatus
string
The status of Activity
GcpResourceTag
object
GCP resource tag information for Tessell-managed resources
8 properties
8 required
RegionOnboardingTrackingDetails
object
Execution details of region onboarding
5 properties
TessellExceptionUserView
object
3 properties
GcpByoaExecutionOutput
object
Output from 'terraform output -json' command executed at customer's GCP account. Each field is a Terraform output block with value, type, and sensitive propert…
6 properties
4 required
AssociatedCloudTypeServiceConsumer
object
Cloud specific details
7 properties
TessellHTTPErrorCode
object
2 properties
AclEligibleUser
object
Eligible user for sharing the entity
5 properties
AzureByoaExecutionOutputPrivateEndpoints
object
Private endpoint resources created as part of arm template deployment
2 properties
1 required
GcpStorage
object
Storage (GCS) information from Terraform output
3 properties
3 required
GcpSubnetOutput
object
Subnet information from Terraform output
1 property
1 required
GcpKeyRing
object
Cloud KMS key ring information
3 properties
3 required
AwsByoaExecutionOutputSubnets
object
2 properties
SubscriptionAwsConfig
AwsByoaExecutionOutputPrivateVPCEndpoint
object
Private VPC endpoint created as part of CF template
2 properties
SubscriptionByoaAzureStaticMetadata
object
Azure metadata for BYOA
6 properties
6 required
SubscriptionGcpOnboardingConfig
object
GCP onboarding configuration for the subscription
2 properties
2 required
AzureByoaExecutionOutputVirtualNetwork
object
Virtual network resources created as part of the arm template deployment
4 properties
3 required
ExadataRegisterVm
object
2 properties
AzureByoaExecutionOutputStorage
object
Security level resources created as part of the arm template deployment
1 property
1 required
GcpVpc
object
VPC network information from Terraform output
4 properties
3 required
SubscriptionResourceList
object
4 properties
GcpSecurity
object
Security (KMS) information from Terraform output
2 properties
2 required
SubscriptionUsersAdminView
object
Details of the subscription users
2 properties
AzureByoaExecutionOutputPrivateEndpoint
object
5 properties
SubscriptionAdminView
object
Admin view of the subscription
11 properties
SubscriptionGcpConfig
AwsByoaExecutionOutput
object
Output from the execution done at customer's account either via cloud formation or via script
4 properties
2 required
AzureByoaExecutionOutputSecurity
object
Security level resources created as part of the arm template deployment
2 properties
2 required
SubscriptionCloudConfigMap
object
Cloud configurations for the subscription
4 properties
Step
object
Step details
8 properties
SubscriptionAzureOnboardingConfig
object
Azure onboarding configuration for the subscription
2 properties
2 required
SubscriptionOciOnboardingConfig
object
OCI onboarding configuration for the subscription
2 properties
2 required
SubscriptionsAdminApiResponse
object
Api response for admin view of subscription
2 properties
AwsByoaExecutionOutputSecurity
object
Security level resources created as part of the cloud formation deployment
2 properties
2 required
AwsByoaExecutionOutputVpc
object
VPC resources created as part of the cloud formation deployment
4 properties
3 required
SubscriptionCloudMetadata
object
Subscription related metadata
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Tessell 12
Other APIs Tessell publishes across the network.
Tessell activity-center API
Tessell Ad Domain API
Tessell Ad Domain Governance API
Tessell agentController API
Tessell alert-controller API
Tessell Authorization API
Tessell Availability Machine API
Tessell azure-netapp-admin-controller API
Tessell azure-netapp-service-controller API
Tessell cloud-resource API
Tessell Compute API
Tessell Compute Governance API
#Subscription