This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Child pages
  • 4.1.x Deleting Domain Mappings via REST API
Skip to end of metadata
Go to start of metadata

Overview 

DescriptionDelete domain mappings of a cluster.
Resource Path

/applications/{applicationId}/domainMappings/{domainName}

HTTP MethodDELETE
Request/Response Format

application/json

> DELETE /api/applications/single-cartridge-app/domainMappings HTTP/1.1
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.24.0 (x86_64-apple-darwin12.0) libcurl/7.24.0 OpenSSL/0.9.8| zlib/1.2.5
> Host: localhost:9443
> Accept: */*
> Content-Type: application/json
> Content-Length: 157
>
* upload completely sent off: 157 out of 157 bytes
< HTTP/1.1 200 OK
< Date: Mon, 06 Apr 2015 06:12:15 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
<
{"status":"success","message":"Domain Mappings deleted successfully: [domain-mappings] [abc.com]"}
curl -X DELETE -H "Content-Type: application/json" -d @'<JSON_PAYLOAD>' -k -v -u admin:admin https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/applications/{applicationId}/domainMappings/{domainName}
  • The path to the JSON file that defines the domain mapping that needs to be deleted needs to be defined as the <JSON_PAYLOAD> value.

  • By default, <STRATOS_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
  • By default, <STRATOS_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

For example:

curl -X DELETE -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/applications/single-cartridge-app/domainMappings/abc.com
 
CLI commandremove-domain-mappings
DescriptionRemove domain mappings of an application.
Command formatremove-domain-mappings <APPLICATION-ID>

REST API response

HTTP status code

200, 500

See the descriptions of the HTTP status codes here.

  • No labels