Schematics Service API

Introduction IBM Cloud® Schematics uses Terraform to help you define cloud resources with code. It makes simple to manage your infrastructure by using scripts. Terraformhttps://www.terraform.io/ is an open source tool that is developed by HashiCorp that allows consistent and reliable provisioning of resources, simple to build complex, multitier cloud environments quickly. IBM Cloud Schematics and Ansible are complementary tools. Ansible helps with provisioning, configuration management, and deploying secure applications. IBM Cloud Schematics supports Ansible Galaxyhttps://cloud.ibm.com/docs/schematics?topic=schematics-getting-started-ansibleansible-galaxy, making automation easier by using roles and collections. The following list provides the detailed documentation. - Schematics getting started tutorialhttps://cloud.ibm.com/docs/schematics?topic=schematics-getting-started - About Schematics documentationhttps://cloud.ibm.com/docs/schematics?topic=schematics-learn-about-schematics - About Schematics and Ansible documentationhttps://cloud.ibm.com/docs/schematics?topic=schematics-getting-started-ansible The code examples on this tab use the IBM Cloud Schematics SDK for Java. Gradle groovy compile group: 'com.ibm.cloud', name: 'schematics', version: '0.+' Maven Maven installation instructionshttps://github.com/IBM/schematics-java-sdk/maven GitHub

MethodPathSummary
GET/v2/locationsList supported locations
GET/v1/resource_groupsList resource groups
GET/v1/versionGet Schematics API information
POST/v2/template_metadata_processorGet variable metadata by parsing the template
GET/v2/workspaces/{w_id}/resourcesList workspace resources
GET/v2/workspaces/{w_id}/output_valuesList workspace output values
GET/v2/workspaces/{w_id}/template_data/{t_id}/values_metadataList workspace variable metadata
GET/v1/workspacesList workspaces
POST/v1/workspacesCreate a workspace
DELETE/v1/workspaces/{w_id}Delete a workspace
GET/v1/workspaces/{w_id}Get workspace details
PATCH/v1/workspaces/{w_id}Update workspace metadata
PUT/v1/workspaces/{w_id}Update workspace
GET/v1/workspaces/{w_id}/templates/readmeShow workspace template readme
PUT/v1/workspaces/{w_id}/template_data/{t_id}/template_repo_uploadUpload a TAR file to your workspace
GET/v1/workspaces/{w_id}/template_data/{t_id}/valuesList workspace input variables
PUT/v1/workspaces/{w_id}/template_data/{t_id}/valuesReplace workspace input variables
GET/v1/workspaces/{w_id}/templates/valuesGet workspace template details
GET/v1/workspaces/{w_id}/template_data/{t_id}/values_metadataList workspace variable metadata
GET/v1/workspaces/{w_id}/output_valuesList workspace output values
GET/v1/workspaces/{w_id}/resourcesList workspace resources
GET/v1/workspaces/{w_id}/state_storesGet Terraform statefile URL
GET/v1/workspaces/{w_id}/runtime_data/{t_id}/state_storeShow Terraform statefile content
GET/v1/workspaces/{w_id}/actions/{activity_id}/logsGet workspace job log URL
GET/v1/workspaces/{w_id}/log_storesGet latest workspace job log URL for all workspace templates
GET/v1/workspaces/{w_id}/runtime_data/{t_id}/log_storeShow latest logs for a workspace template
GET/v1/workspaces/{w_id}/runtime_data/{t_id}/log_store/actions/{activity_id}Show logs for a workspace job
GET/v2/actionsList actions
POST/v2/actionsCreate an action
DELETE/v2/actions/{action_id}Delete an action
GET/v2/actions/{action_id}Get action details
PATCH/v2/actions/{action_id}Update an action
PUT/v2/actions/{action_id}/template_repo_uploadUpload a TAR file to an action
GET/v1/workspaces/{w_id}/actionsList workspace jobs
DELETE/v1/workspaces/{w_id}/actions/{activity_id}Stop the workspace job
GET/v1/workspaces/{w_id}/actions/{activity_id}Get workspace job details
PUT/v1/workspaces/{w_id}/commandsRun Terraform Commands
PUT/v1/workspaces/{w_id}/applyPerform a Schematics `apply` job
PUT/v1/workspaces/{w_id}/destroyPerform a Schematics `destroy` job
POST/v1/workspaces/{w_id}/planPerform a Schematics `plan` job
PUT/v1/workspaces/{w_id}/refreshPerform a Schematics `refresh` job
GET/v2/jobsList jobs
POST/v2/jobsCreate a job
DELETE/v2/jobs/{job_id}Stop the running Job, and delete the Job
GET/v2/jobs/{job_id}Get a job
PUT/v2/jobs/{job_id}Update a job
GET/v2/jobs/{job_id}/logsGet job logs
GET/v2/jobs/{job_id}/filesGet output files from the Job record
POST/v1/workspace_jobsDelete one or more workspace
GET/v1/workspace_jobs/{wj_id}/statusGet the workspace deletion job status
GET/v2/inventoriesList inventory definitions
POST/v2/inventoriesCreate an inventory definition
DELETE/v2/inventories/{inventory_id}Delete an inventory definition
GET/v2/inventories/{inventory_id}Get an inventory definition
PUT/v2/inventories/{inventory_id}Update an inventory definition
GET/v2/resources_queryList resource queries
POST/v2/resources_queryCreate resource query
DELETE/v2/resources_query/{query_id}Delete resources query
GET/v2/resources_query/{query_id}Get resources query
POST/v2/resources_query/{query_id}Run the resource query
PUT/v2/resources_query/{query_id}Update resources query definition
GET/v2/agentsList agents
POST/v2/agentsCreate an agent
DELETE/v2/agents/{agent_id}Delete agent
GET/v2/agents/{agent_id}Get agent details
PUT/v2/agents/{agent_id}Update agent
GET/v2/agents/versionsGet agent versions
PUT/v2/agents/{agent_id}/prsRun pre-requisite scanner job
PUT/v2/agents/{agent_id}/healthRun agent health check
PUT/v2/agents/{agent_id}/deployRun the agent deployment job
DELETE/v2/agents/{agent_id}/resourcesDelete resources provisioned by agent
GET/v2/settings/kmsGet a KMS settings
PUT/v2/settings/kmsUpdate a KMS settings
GET/v2/settings/kms_instancesList KMS instances
GET/v2/settings/policiesList policies
POST/v2/settings/policiesCreate a policy account
DELETE/v2/settings/policies/{policy_id}Delete policy
GET/v2/settings/policies/{policy_id}Get policy
PATCH/v2/settings/policies/{policy_id}Update policy