POST Config Data

POST Config Data

Import an exported Operations for Logs configuration.

The following configuration can be imported based on the provided parameters:

  • General configuration (CEIP, System notification recipients, etc.)
  • NTP configuration
  • Log forwarder configuration
  • SMTP configuration
  • Archiving settings
  • Agents groups configuration

Imported configuration does NOT include the following information:

  • Cluster configuration (e.g. the number of nodes, VIP configuration, etc.) Exporting VIP configuration might result in multiple clusters having the same VIP, which would cause issues with ingestion, log forwarding, etc.
  • Hosts information
  • Patterns and fields extracted during machine learning
  • Agents configuration
  • Local users. Local users aren't migrated for security reasons so that passwords are exposed in the exported configuration file.
  • Active Directory and vIDM configurations aren't migrated for security reasons, as exporting these configurations would expose the passwords.
  • Content packs and user content, such as dashboards, alerts, etc. Content migration can be addressed with separate APIs designed to export and import content packs and user content.
  • SSL configuration
  • vSphere integration configuration isn't migrated for security reasons, as exporting this configuration would expose the passwords.
  • VMware Aria Operations integration configuration isn't migrated for security reasons, as exporting this configuration would expose the passwords.

Configuration import process consists of two steps:

  1. The exported configuration file should be uploaded as binary data with the "Content-Type: applications/octet-stream" header.
  2. Once the file is uploaded, the configurations can be applied by setting the "Content-Type: applications/json" header and providing the items to exclude in the JSON body.
Request
URI
POST
https://{api_host}/api/v1/config/data
COPY
Request Body
config.data.post.request of type(s) application/json
Optional 
"{includeNtpConfig=false, includeAgentsGroups=false}"
Authentication
This operation uses the following authentication methods.
Responses
200
Operation doesn't return any data structure

Response Headers

string
Warning

Additional information about the life-cycle status of the API.

string
VMware-LI-API-Status

Indicates the life-cycle status of the API.


202

Applying the imported configuration has partially succeeded.

{
    "GeneralConfiguration": "Successfully configured.",
    "Time": "Successfully configured.",
    "EventForwarder": "Successfully configured.",
    "SMTP": "Successfully configured.",
    "Archiving": "Successfully configured.",
    "includeAgentsGroups": "Successfully configured."
}

401

The request was refused because it lacks valid authentication credentials. This can happen if the Authorization header was missing, or if it contained an invalid session ID.

Obtain a new session ID and retry the request, or make an unauthenticated request without the Authorization header.

"Invalid session ID"

440

The request was refused because the session ID has expired. Obtain a new session ID from /api/v1/sessions.

"Login Timeout"

500

Internal error while processing the client request

Returns error of type(s) application/json 
{
    "errorMessage": "The operation failed due to an internal error."
}
string
errorMessage
Required

A message describing the error.

string
errorCode
Optional

A code representing the type of error.

Possible values are : LIMIT_ERROR, FIELD_ERROR, TEST_ERROR, JSON_FORMAT_ERROR, LICENSE_ERROR, VSPHERE_INTEGRATION_ERROR, VROPS_INTEGRATION_ERROR, UPGRADE_ERROR, SEARCH_ERROR, AGENT_ERROR, RBAC_COMMON_ERROR, RBAC_USERS_ERROR, RBAC_GROUPS_ERROR, RBAC_ADGROUPS_ERROR, RBAC_DATASETS_ERROR, RBAC_VIDM_GROUPS_ERROR, RBAC_VIDB_GROUPS_ERROR, SECURITY_ERROR, DEPLOYMENT_ERROR, SUPPORT_BUNDLE_ERROR, LOAD_BALANCER_ERROR, VIDM_ERROR, VIDB_ERROR, QUERY_ERROR, SSL_CERTIFICATE_ERROR, PROXY_ERROR,
object
errorDetails
Optional

Dynamic error details, where the field name can vary depending on the request field and error code.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/v1/config/data
Deprecated
On This Page
Config Operations
GET
GET Config
Deprecated
PUT
PUT Config
Deprecated
GET
GET Config Data
Deprecated
POST
POST Config Data
Deprecated