Follow
us- Home
- API and CLI Reference
- API Basics
- CURL Example
CURL Example
What is CURL
CURL, an abbreviation for Client URL, serves as a command-line utility employed by developers to exchange data with servers. Essentially, CURL enables communication with a server by defining the location (URL format) and the data to be transmitted. Supporting various protocols such as HTTP and HTTPS, CURL operates across nearly all platforms, making it well-suited for facilitating communication from nearly any device equipped with a command-line interface and network connectivity.
Here's a basic example of how to use CURL to interact with the xcware API:
To interact with the xcware API, you'll need to ensure that you're sending POST requests with JSON data and expect JSON-structured data in response.
CURL -H (Header Options)
Now that we've laid down the groundwork, let's delve into the essential headers needed to construct a valid POST request for the xcware API.
x-access-account
This header denotes the account ID and is required for any request. You can find your account ID in the "Actions" menu situated at the top right corner of the Nexus interface.
x-access-authorization
This header signifies the access key linked to the roles and policies within the specified account, and it's a requisite for all requests. Please obtain your access key from your system administrator.
x-secret-key
This header indicates the secret key tied to the specified account, and it's mandatory for all requests. Please obtain your secret key from your system administrator.
x-api
This header defines the name of the API containing the commands and is obligatory. Refer to the API Builder for potential API names.
x-api-command
This header specifies the name of the function to be executed and is mandatory. Refer to the API Builder for potential command names.
CURL -d (Data Option)
The -d option signifies the JSON structured input data transmitted to the API task and is mandatory. For potential data input options, refer to the API Builder.
CURL, an abbreviation for Client URL, serves as a command-line utility employed by developers to exchange data with servers. Essentially, CURL enables communication with a server by defining the location (URL format) and the data to be transmitted. Supporting various protocols such as HTTP and HTTPS, CURL operates across nearly all platforms, making it well-suited for facilitating communication from nearly any device equipped with a command-line interface and network connectivity.
Here's a basic example of how to use CURL to interact with the xcware API:
To interact with the xcware API, you'll need to ensure that you're sending POST requests with JSON data and expect JSON-structured data in response.
Copy
curl -X POST \
-H "x-access-account: YOUR_ACCOUNTID" \
-H "x-access-authorization: YOUR_ACCESS_KEY" \
-H "x-secret-key: YOUR_SECRET_KEY" \
-H "x-api: API_NAME" \
-H "x-api-command: API_COMMAND_NAME" \
-d "{\"key\": \"value\"}" \
https://your_nexus_server_or_ip/api/v3/CURL -H (Header Options)
Now that we've laid down the groundwork, let's delve into the essential headers needed to construct a valid POST request for the xcware API.
x-access-account
This header denotes the account ID and is required for any request. You can find your account ID in the "Actions" menu situated at the top right corner of the Nexus interface.
x-access-authorization
This header signifies the access key linked to the roles and policies within the specified account, and it's a requisite for all requests. Please obtain your access key from your system administrator.
x-secret-key
This header indicates the secret key tied to the specified account, and it's mandatory for all requests. Please obtain your secret key from your system administrator.
x-api
This header defines the name of the API containing the commands and is obligatory. Refer to the API Builder for potential API names.
x-api-command
This header specifies the name of the function to be executed and is mandatory. Refer to the API Builder for potential command names.
CURL -d (Data Option)
The -d option signifies the JSON structured input data transmitted to the API task and is mandatory. For potential data input options, refer to the API Builder.
Get Started with API Builder
