View and Manage the Visual Builder Instance
After creating the Visual Builder instance, you can view its details and manage it from the OCI Console.
- Open the OCI Console.
- In the upper-left corner, click Navigation Menu
.
- Select Developer Services in the menu, then select Visual Builder in the list of services.
If you want to change the region, you can use the dropdown list at the top of the page to select a different region.
- From the Compartment drop-down list, select the Visual Builder instance's compartment.
- Click the Visual Builder instance.
You can perform these actions from the instances page:
To do this ... | Do this: |
---|---|
Open the Visual Builder homepage | Click Service Homepage. |
Start or stop an instance | Start or Stop a Visual Builder Instance |
Change the node count | Scale a Visual Builder Instance |
Configure a custom endpoint with the instance | Map Your Custom Endpoint with Your Visual Builder Instance. |
Add or edit tags | Manage Tags |
Download activity logs | In the
Activities section, click
Action
![]() |
Download activity error logs | In the
Activities section, click
Action
![]() |
Terminate an instance | Terminate a Visual Builder Instance |
Access Visual Builder from the OCI Console
If you haven't bookmarked the Visual Builder home page in your browser, you can access it from the OCI Console.
Start or Stop a Visual Builder Instance
To save your billing cost, you can stop a Visual Builder instance. Billing is stopped for the duration that the instance is stopped and resumes when you start it. In the duration an instance is stopped, your organization's members can't access its applications.
If the instance has more than one node, you'll need to edit the instance's details to set the number of nodes to '
1
' before you can stop the instance.
- Open the VB instance's details page.
- Click Start or Stop to start or stop an instance.
- Click Yes when prompted to confirm your selection.
Move a Visual Builder Instance to Another Compartment
You can move a Visual Builder instance to a different compartment. Before you move the instance, remember that moving an instance can potentially change who has access to the instance. Make sure that users who have access to the current Visual Builder instance's compartment can access the instance in the new compartment as well.
- Open the VB instance's details page.
- From the More Actions drop-down menu, select Move Resource.
- In the Move Resource to a Different Compartment dialog box, select the compartment and click Move Resource.
Editing the Visual Builder Instance
You can edit your Visual Builder instance to scale the number of nodes in your instance and to add (or update) a custom endpoint. You cannot rename an instance.
You cannot split a single instance into two parts (for example, into test and development parts). Instead, you must create separate instances for each part.
Scale a Visual Builder Instance
To meet your changing workload requirements, increase performance or to reduce your costs, you can increase or decrease the Visual Builder instance’s node count. By default, a Visual Builder has one node.
- Open the Visual Builder instance's details page.
- Click Edit.
- In the Nodes field, enter the number of nodes. Click Save Changes.
Create and Configure a Custom Endpoint for Your Visual Builder Instance
You can map a custom endpoint to a Visual Builder instance and use it to access the instance instead of the original URL generated in the OCI Console.
mycustom.example.org
) for your Visual Builder instance. Associating a custom endpoint with your Visual Builder instance doesn't affect the original instance URL. You'll be able to
access your instance using the custom endpoint URL as well as the original
instance URL.
These instructions assume you have direct access to a Visual Builder instance. If you are using the instance behind a WAF or an API Gateway, skip the certificate-related instructions provided here (from Step 3 onwards) and follow the WAF or API gateway certificate instructions instead. See WAF Certificates or Setting Up Custom Domains and TLS Certificates for API Gateways
Map Your Custom Endpoint with Your Visual Builder Instance
To map a custom endpoint to a Visual Builder instance, get the custom hostname for the Visual Builder instance and the OCI vault's compartment name, vault's name, and the secret key where you've uploaded the SSL certificate.
After you've mapped the instance, update the custom endpoint DNS record to the original instance hostname. As a best practice, update the CNAME of the DNS record with the hostname of the original instance endpoint.
Manage Tags
OCI tags enable you to tag your OCI resources, such as your instance, and help you organize resources based on your business needs. You can manage tags from the Instance Details page.
If you're new to OCI tags, see Tagging Overview.
Action | How To |
---|---|
Add a tag |
|
Edit a tag |
|
Remove a tag |
|
You can see the Add Tags item in the More Actions menu in this image.

Terminate a Visual Builder Instance
Terminating a Visual Builder instance removes its applications and data. You can't undo the terminate action.
View Instance Metrics
You can use the Metrics pane in the OCI Console to view data about your instance's resource consumption and the number of logged-in users.
To view instance metrics during a specific period of time.
- Open the Visual Builder Instance Details page of your instance.
- Click Metrics under Resources in the left navigation pane.
- In the Metrics pane, select the Start Time and End Time of the period you want to examine.
You can also select a period in the Quick Selects dropdown list.
The Metrics pane contains three charts that display details about your instance: OCPU Consumption, Concurrent Users and Database Usage. Each chart contains Interval and Statistic dropdown menus for modifying how the metrics are displayed. When you hover over a chart, a tooltip is displayed with more detailed metrics.

OCPU Consumption
The OCPU Consumption chart displays the percentage of each of the instance's CPUs that is being used at a given time.

Concurrent Users
The Concurrent Users chart displays the number of users that are logged in to the instance at a given time.

Database Usage
The Database Usage chart displays how much data is stored in the database at a given time. To see the usage, you need to define a period of time, either by using the Start Time and End Time fields to select dates, or the Quick Select to select a period (for example, "Last 12 hours").

View Services Associated With Your Instance
You can use the Associated Services table in the OCI Console to see a list of the services that are attached to your VB instance.
When a VB instance is created by a service other than Visual Builder, for example, if an instance is created by enabling Visual Builder in Oracle Integration Cloud (OIC) service, the service and the VB instance are then "attached" to each other. If a VB instance is attached to a service, the attached service is listed in the Associated Services table in the OCI Console.
To open the Associated Services table:
- Open the Visual Builder Instance Details page, and then click Associated services under the Resources menu.
You can open the home page of the attached service using the Service console URL in the table.

In some cases, an attachment can be via another service. For example, an Oracle Cloud Application service might trigger an OIC service to create a Visual Builder instance. In this case, the Associated Services table would show this relationship using "parent" and "child" labels: the Oracle Cloud Application service's role would be "Parent", and the OIC service's role would be "Child".