The API Authentication for VinylDNS is modeled after the AWS Signature Version 4 Signing process. The AWS documentation for it can be found
-here. Similar to how the AWS Signature Version 4 signing
-process adds authentication information to AWS requests, VinylDNS’s API Authenticator also adds authentication information to every API request.
-
-
VinylDNS API Authentication Process
-
-
-
Retrieve the Authorization HTTP Header (Auth Header) from the HTTP Request Context.
-
Parse the retrieved Auth Header into an AWS String to Sign structure which should be in the form:
Extract the access key from the Auth Header and search for the account associated with the access key.
-
Validate the signature of the request.
-
Build the authentication information, which essentially contains all the authorized accounts for the signed in user.
-
-
-
Authentication Failure Response
-
-
If any these validations fail, a 401 (Unauthorized) or a 403 (Forbidden) error will be thrown; otherwise unanticipated exceptions will simply bubble out and result as 500s or 503s.
-
-
-
If the Auth Header is not found, then a 401 (Unauthorized) error is returned.
-
If the Auth Header cannot be parsed, then a 403 (Forbidden) error is returned.
-
If the access key cannot be found, then a 401 (Unauthorized) error is returned.
-
If the request signature cannot be validated, then a 403 (Forbidden) error is returned.
-
-
\ No newline at end of file
diff --git a/api/batchchange-errors.html b/api/batchchange-errors.html
deleted file mode 100644
index 00d0202bf..000000000
--- a/api/batchchange-errors.html
+++ /dev/null
@@ -1,460 +0,0 @@
-VinylDNS: Batch Change Errors
Since all of the batch changes are being validated simultaneously, it is possible to encounter a variety of errors for a given change. Each change that is associated with errors will have its own list of errors containing one or more errors; any changes without the errors list have been fully validated and are good to submit. If any change in the batch is deemed invalid for any reason, no changes in the batch will be applied. These types of errors will probably account for the majority of errors that users encounter.
-
-
By-change accumulated errors are errors that get collected at different validation stages and correspond to individual change inputs. By-change accumulated errors are grouped into the following stages:
-
-
-
Independent input validations: Validate invalid data input formats and values.
-
Record and zone discovery: Resolve record and zone from fully-qualified input name.
-
Dependent context validations: Check for sufficient user access and conflicts with existing records or other submissions within the batch.
-
-
-
Since by-change accumulated errors are collected at different stages, errors at later stages may exist but will not appear unless errors at earlier stages are addressed.
-
-
EXAMPLE ERROR RESPONSE BY CHANGE
-
-
[
- {
- "changeType": "Add",
- "inputName": "good-A.another.example.com.",
- "type": "A",
- "ttl": 200,
- "record": {
- "address": "1.2.3.4"
- }
- },
- {
- "changeType": "Add",
- "inputName": "duplicate.example.com",
- "type": "CNAME",
- "ttl": 200,
- "record": {
- "cname": "test.example.com."
- },
- "errors": [
- "Record with name "duplicate.example.com." is not unique in the batch change. CNAME record cannot use duplicate name."
- ]
- },
- {
- "changeType": "Add",
- "inputName": "duplicate.example.com",
- "type": "A",
- "ttl": 300,
- "record": {
- "address": "1.2.3.4"
- }
- },
- {
- "changeType": "Add",
- "inputName": "bad-ttl-and-invalid-name$.sample.com.”,
- "type": "A",
- "ttl": 29,
- "record": {
- "address": "1.2.3.4"
- },
- "errors": [
- "Failed validation 29, TTL must be between 30 and 2147483647.",
- "Failed validation bad-ttl-and-invalid-name$.sample.com., valid domain names are a series of one or more labels joined by dots and terminate on a dot."
- ]
- }
-]
-
Invalid domain name: "<input>", valid domain names must be letters, numbers, and hyphens, joined by dots, and terminate with a dot.
-
-
-
-
Details:
-
-
Fully qualified domain names, must be comprised of labels, separated by dots.
-A label is a combination of letters, digits, and hyphens.
-They must also be absolute, which means they end with a dot.
-
-
Syntax:
-
-
<domain> ::= <subdomain> | " "
-
-<subdomain> ::= <label> | <subdomain> "." <label>
-
-<label> ::= <letter> [ [ <ldh-str> ] <let-dig> ]
-
-<ldh-str> ::= <let-dig-hyp> | <let-dig-hyp> <ldh-str>
-
-<let-dig-hyp> ::= <let-dig> | "-"
-
-<let-dig> ::= <letter> | <digit>
-
-<letter> ::= any one of the 52 alphabetic characters A through Z in
-upper case and a through z in lower case
-
-<digit> ::= any one of the ten digits 0 through 9
-
Invalid length: "<input>", length needs to be between <minLengthInclusive> and <maxLengthInclusive> characters.
-
-
-
-
Details:
-
-
The length of the input did not fit in the range in [minLengthInclusive, maxLengthInclusive].
-
-
3. Invalid Record Type
-
-
Error Message:
-
-
Invalid record type: "<input>", valid record types include <valid record types>.
-
-
-
-
Details:
-
-
The record type input must match one of the valid record types. Not all DNS record types are currently supported.
-
-
4. Invalid IPv4 Address
-
-
Error Message:
-
-
Invalid IPv4 address: "<input>"
-
-
-
-
Details:
-
-
The IPv4 address input is not a valid IPv4 address. Accepted inputs must be in dotted-decimal notation, with four
-groups of three decimal digits, separated by periods. Leading zeros in groups can be omitted.
-
-
Range: 0.0.0.0 - 255.255.255.255
-
-
Examples:
-
-
-
1.1.1.1
-
10.234.0.62
-
-
-
5. Invalid IPv6 Address
-
-
Error Message:
-
-
Invalid IPv6 address: "<input>".
-
-
-
-
Details:
-
-
The IPv6 address input is not a valid IPv6 address. Accepted inputs must be eight groups of four hexadecimal digits,
-separated by colons. Leading zeros in groups can be emitted. Consecutive groups of all zeros can be replaced by a double colon.
The IP address input is not a valid IPv4 or IPv6 address.
-
-
7. Invalid TTL
-
-
Error Message:
-
-
Invalid TTL: "<input>", must be a number between 30 and 2147483647.
-
-
-
-
Details:
-
-
Time-to-live must be a number in the range [30, 2147483647].
-
-
8. Invalid Batch Record Type
-
-
Error Message:
-
-
Invalid Batch Record Type: "<input>", valid record types for batch changes include <valid record types>.
-
-
-
-
Details:
-
-
The DNS record type is not currently supported for batch changes.
-
-
9. Zone Discovery Failed
-
-
Error Message:
-
-
Zone Discovery Failed: zone for "<input>" does not exist in VinylDNS. If zone exists, then it must be created in VinylDNS.
-
-
-
-
Details:
-
-
Given an inputName, VinylDNS will determine the record and zone name for the requested change. For most records, the record
-names are the same as the zone name (apex), or split at at the first ‘.’, so the inputName ‘rname.zone.name.com’ will be split
-into record name ‘rname’ and zone name ‘zone.name.com’ (or ‘rname.zone.name.com’ for both the record and zone name if it’s an apex record).
-For PTR records, there is logic to determine the appropriate reverse zone from the given IP address.
-
-
If this logic cannot find a matching zone in VinylDNS, you will see this error.
-In that case, you need to connect to the zone in VinylDNS.
-Even if the zone already exists outside of VinylDNS, it has to be added to VinylDNS to modify records.
-
-
10. Record Already Exists
-
-
Error Message:
-
-
Record "<input>" Already Exists: cannot add an existing record; to update it, issue a DeleteRecordSet then an Add.
-
-
-
-
Details:
-
-
A record with the given name already exists, and cannot be duplicated for the given type.
-
-
11. Record Does Not Exist
-
-
Error Message:
-
-
Record "<input>" Does Not Exist: cannot delete a record that does not exist.
-
-
-
-
Details:
-
-
A record with the given name could not be found in VinylDNS.
-If the record exists in DNS, then you should sync the zone for that record to bring VinylDNS up to date with what is in the DNS backend.
-
-
12. CNAME Conflict
-
-
Error Message:
-
-
CNAME conflict: CNAME record names must be unique. Existing record with name "<name>" and type "<type>" conflicts with this record.
-
-
-
-
Details:
-
-
A CNAME record with the given name already exists. CNAME records must have unique names.
-
-
13. User Is Not Authorized
-
-
Error Message:
-
-
User "<user>" is not authorized.
-
-
-
-
Details:
-
-
User must either be in the admin group for the zone being changed, or have an ACL rule.
-
-
14. Record Name Not Unique In Batch Change
-
-
Error Message:
-
-
Record "<name>" Name Not Unique In Batch Change: cannot have multiple "<type>" records with the same name.
-
-
-
-
Details:
-
-
Certain record types do not allow multiple records with the same name. If you get this error, it means you have
-illegally input two or more records with the same name and one of these types.
-
-
15. Invalid Record Type In Reverse Zone
-
-
Error Message:
-
-
Invalid Record Type In Reverse Zone: record with name "<name>" and type "<type>" is not allowed in a reverse zone.
-
-
-
-
Details:
-
-
Not all record types are allowed in a DNS reverse zone. The given type is not supported.
-
-
FULL-REQUEST ERRORS
-
-
Fail-request errors cause the batch change processing to abort immediately upon encounter.
Unprocessable Entity - the batch does not contain any changes, thus cannot be processed.
-
-
-
-
-
ERROR MESSAGE:
-
-
Batch change contained no changes. Batch change must have at least one change, up to a maximum of <limit> changes.
-
-
-
-
DETAILS:
-
-
There were no changes found in the create batch change request. A batch must contain at least one change and no more than 20 changes.
-
-
2. CHANGE LIMIT EXCEEDED
-
-
HTTP RESPONSE CODE
-
-
-
-
-
Code
-
description
-
-
-
-
-
413
-
Request Entity Too Large - the batch size exceeds the maximum number of single changes, currently set to 20.
-
-
-
-
-
ERROR MESSAGE:
-
-
Cannot request more than <limit> changes in a single batch change request
-
-
-
-
DETAILS:
-
-
The number of change inputs in the create batch change request exceeds the max change input limit threshold, which is currently set to 20.
-
-
3. BATCH CHANGE NOT FOUND
-
-
HTTP RESPONSE CODE
-
-
-
-
-
Code
-
description
-
-
-
-
-
404
-
Not Found - batch change not found for specified ID in get batch change request.
-
-
-
-
-
ERROR MESSAGE:
-
-
Batch change with id <id> cannot be found
-
-
-
-
DETAILS:
-
-
The batch ID specified in the get batch change request does not exist.
-
-
4. MALFORMED JSON ERRORS
-
-
DETAILS:
-
-
If there are issues with the JSON provided in a batch change request, errors will be returned (not in a by-change format) and none of the batch change validations will run.
\ No newline at end of file
diff --git a/api/batchchange-model.html b/api/batchchange-model.html
deleted file mode 100644
index ef0a62475..000000000
--- a/api/batchchange-model.html
+++ /dev/null
@@ -1,285 +0,0 @@
-VinylDNS: Batch Change Model
To update an existing record, you must delete the record first and add the record again with the updated changes.
-
-
Batch changes are also susceptible to the following restrictions:
-
-
Current supported record types for batch change are: A, AAAA, CNAME, and PTR.
-
Batch change requests must contain at least one change.
-
The maximum number of single changes within a batch change is currently set to 20.
-
Access permissions will follow existing rules (admin group or ACL access). Note that an update (delete and add of the same record name, zone and record type combination) requires Write access.
-
-
-
BATCH CHANGE ATTRIBUTES
-
-
-
-
-
name
-
type
-
description
-
-
-
-
-
userId
-
string
-
The unique identifier of the user that created the batch change.
-
-
-
userName
-
string
-
The username of the user that created the batch change.
-
-
-
comments
-
string
-
Optional comments about the batch change.
-
-
-
createdTimestamp
-
date-time
-
The timestamp (in GMT) when the batch change was created.
Pending - at least one change in batch in still in pending state; Complete - all changes are in complete state; Failed - all changes are in failure state; PartialFailure - some changes have failed and the rest are complete.
-
-
-
id
-
string
-
The unique identifier for this batch change.
-
-
-
-
-
SINGLE CHANGE ATTRIBUTES
-
-
A successful batch change response consists of a corresponding SingleAddChange or SingleDeleteChange for each batch change input. See the batch change create page for details on constructing a batch change request.
-
-
SingleAddChange
-
-
-
-
-
name
-
type
-
description
-
-
-
-
-
changeType
-
ChangeInputType
-
Type of change input. Can either be an Add or DeleteRecordSet.
-
-
-
inputName
-
string
-
The fully-qualified domain name of the record which was provided in the create batch request.
-
-
-
type
-
RecordType
-
Type of DNS record, supported records for batch changes are currently: A, AAAA, CNAME, and PTR.
Creates a batch change with SingleAddChanges and/or SingleDeleteChanges across different zones. A delete and add of the same record will be treated as an update on that record set. Regardless of the input order in the batch change, all deletes for the same recordset will be logically applied before the adds.
-
-
Current supported record types for creating a batch change are: A, AAAA, CNAME, and PTR. A batch must contain at least one change and no more than 20 changes.
-
-
HTTP REQUEST
-
-
-
POST /zones/batchrecordchanges
-
-
-
Note that the batch change request inputs are a subset of the full batch change model.
-
-
HTTP REQUEST PARAMS
-
-
-
-
-
name
-
type
-
required?
-
description
-
-
-
-
-
comments
-
string
-
no
-
Optional comments about the batch change.
-
-
-
changes
-
Array of ChangeInput
-
yes
-
Set of ChangeInputs in the batch change. A ChangeInput is an AddChangeInput or DeleteChangeInput. Type is inferred from specified changeType.
-
-
-
-
-
AddChangeInput
-
-
-
-
-
name
-
type
-
required?
-
description
-
-
-
-
-
changeType
-
ChangeInputType
-
yes
-
Type of change input. Must be set to Add for AddChangeInput.
-
-
-
inputName
-
string
-
yes
-
The fully qualified domain name of the record being added. For PTR, the input name is a valid IPv4 or IPv6 address.
-
-
-
type
-
RecordType
-
yes
-
Type of DNS record. Supported records for batch changes are currently: A, AAAA, CNAME, and PTR.
-
-
-
ttl
-
long
-
yes
-
The time-to-live in seconds. The minimum and maximum values are 30 and 2147483647, respectively.
The first two items in the changes list are SingleAddChanges of an A record and a PTR record. Note that for the PTR record, the inputName is a valid IP address. The third item is a delete of a CNAME record. The last two items represent an update (delete & add) of an AAAA record with the fully qualified domain name “update.another.example.com.”.
-
-
HTTP RESPONSE TYPES
-
-
-
-
-
Code
-
description
-
-
-
-
-
202
-
Accepted - The batch change is queued and is returned in the response body.
Forbidden - The user does not have the access required to perform the action.
-
-
-
413
-
Request Entity Too Large - Cannot request more than 20 changes in a single batch change request.
-
-
-
422
-
Unprocessable Entity - the batch does not contain any changes, thus cannot be processed.
-
-
-
-
-
A batch change goes through numerous validations before it is processed. This results in corresponding BadRequest or error responses. View the full list of batch change errors here.
-
-
HTTP RESPONSE ATTRIBUTES
-
-
On success, the response from create batch change includes the fields the user input, as well as some additional information provided by the system. This response is the same as that of get batch change.
\ No newline at end of file
diff --git a/api/create-group.html b/api/create-group.html
deleted file mode 100644
index f7b963412..000000000
--- a/api/create-group.html
+++ /dev/null
@@ -1,190 +0,0 @@
-VinylDNS: Create Group
OK - The group has been created and the group info is returned in the response body
-
-
-
400
-
Bad Request - The group was invalid
-
-
-
401
-
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
-
-
-
404
-
Not Found - A user id was not found
-
-
-
409
-
Conflict - A group with the same name already exists
-
-
-
-
-
HTTP RESPONSE ATTRIBUTES
-
-
-
-
-
name
-
type
-
description
-
-
-
-
-
id
-
string
-
Unique UUID of the group
-
-
-
name
-
string
-
The name of the group
-
-
-
email
-
string
-
The email distribution list of the group
-
-
-
description
-
string
-
The group description, the group will not have this attribute if it was not included in the create request
Accepted - The record set is valid and has been accepted for processing; the record set change resource is returned
-
-
-
400
-
Bad Request - The zone specified is not Active; typically because the zone has no connection information
-
-
-
401
-
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
-
-
-
403
-
Forbidden - The user does not have the access required to perform the action
-
-
-
404
-
Not Found - the zone with the id specified was not found
-
-
-
409
-
Conflict - A record set with the same name and type already exists in the zone
-
-
-
422
-
Unprocessable Entity
-
-
-
-
-
HTTP RESPONSE ATTRIBUTES
-
-
-
-
-
name
-
type
-
description
-
-
-
-
-
zone
-
map
-
contains information about the zone when the change was created
-
-
-
recordSet
-
map
-
contains the recordset model
-
-
-
userId
-
string
-
the user id that initiated the change
-
-
-
changeType
-
string
-
type of change requested (Create, Update, Delete); in this case Create
-
-
-
created
-
string
-
the time (GMT) the change was initiated
-
-
-
id
-
string
-
the id of the change. This is not the id of the recordset
\ No newline at end of file
diff --git a/api/create-zone.html b/api/create-zone.html
deleted file mode 100644
index c02d13153..000000000
--- a/api/create-zone.html
+++ /dev/null
@@ -1,139 +0,0 @@
-VinylDNS: Create Zone
Connects user to an existing zone. User must be a member of the group that has access to the zone. Connection info is optional,
-if no info is provided the default VinylDNS connections will be used
-
-
HTTP REQUEST
-
-
-
POST /zones
-
-
-
HTTP REQUEST PARAMS
-
-
-
-
-
zone fields - adminGroupId, name, and email are required - refer to zone model
Accepted - The zone change is queued and is returned in the response body
-
-
-
400
-
Bad Request - Connection failed, or group did not have access to the zone
-
-
-
401
-
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
-
-
-
403
-
Forbidden - the user does not have the access required to perform the action
\ No newline at end of file
diff --git a/api/delete-group.html b/api/delete-group.html
deleted file mode 100644
index f6297ef56..000000000
--- a/api/delete-group.html
+++ /dev/null
@@ -1,127 +0,0 @@
-VinylDNS: Delete Group
OK - The group has been delete and the group info is returned in the response body
-
-
-
400
-
Bad Request - The group could not be deleted
-
-
-
401
-
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
-
-
-
403
-
Forbidden - The user does not have the access required to perform the action
-
-
-
404
-
Not Found - The group was not found
-
-
-
-
-
HTTP RESPONSE ATTRIBUTES
-
-
-
-
-
name
-
type
-
description
-
-
-
-
-
id
-
string
-
Unique UUID of the group
-
-
-
name
-
map
-
The name of the group
-
-
-
email
-
string
-
The email distribution list of the group
-
-
-
description
-
string
-
The group description, the group will not have this attribute if it was not set
Accepted - the delete is valid and has been accepted for processing; the record set change resource is returned in the response body
-
-
-
400
-
Bad Request - the zone being updated is not active; typically because the connection information does not exist for the zone
-
-
-
401
-
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
-
-
-
403
-
Forbidden - The user does not have the access required to perform the action
-
-
-
404
-
Not Found - Zone or RecordSet not found
-
-
-
409
-
Conflict - There is an existing pending change against this zone
-
-
-
-
-
HTTP RESPONSE ATTRIBUTES
-
-
-
-
-
name
-
type
-
description
-
-
-
-
-
zone
-
map
-
contains information about the zone when the change was created
-
-
-
recordSet
-
map
-
contains the recordset model
-
-
-
userId
-
string
-
the user id that initiated the change
-
-
-
changeType
-
string
-
type of change requested (Create, Update, Delete); in this case Delete
-
-
-
created
-
string
-
the time (GMT) the change was initiated
-
-
-
id
-
string
-
the id of the change. This is not the id of the recordset
\ No newline at end of file
diff --git a/api/delete-zone.html b/api/delete-zone.html
deleted file mode 100644
index 24e8d95e4..000000000
--- a/api/delete-zone.html
+++ /dev/null
@@ -1,126 +0,0 @@
-VinylDNS: Delete Zone
Abandons an existing zone that has already been connected to.
-The zone will be disconnected from VinylDNS, but the RecordSets still exist in the backend DNS zone.
-To delete the RecordSets see Delete RecordSet
-
-
Note: We do not recommend that you abandon zones, as your zone history will be lost after the Delete. This endpoint is provided in certain situations where a zone was incorrectly started.
-
-
HTTP REQUEST
-
-
-
DELETE /zones/{zoneId}
-
-
-
HTTP RESPONSE TYPES
-
-
-
-
-
Code
-
description
-
-
-
-
-
202
-
Accepted - The change has been queued and is returned in the response body
-
-
-
400
-
Bad Request - Zone was not empty and contains records
-
-
-
401
-
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
-
-
-
403
-
Forbidden - The user does not have the access required to perform the action
-
-
-
404
-
Not Found - Zone not found
-
-
-
409
-
Conflict - Zone is unavailable
-
-
-
-
-
HTTP RESPONSE ATTRIBUTES
-
-
-
-
-
name
-
type
-
description
-
-
-
-
-
zone
-
map
-
zone being deleted
-
-
-
userId
-
string
-
the user id that initiated the change
-
-
-
changeType
-
string
-
type of change requested (Create, Update, Sync, Delete); in this case Delete
-
-
-
created
-
string
-
the time (GMT) the change was initiated
-
-
-
id
-
string
-
the id of the change. This is not the id of the zone
\ No newline at end of file
diff --git a/api/get-batchchange.html b/api/get-batchchange.html
deleted file mode 100644
index af442238f..000000000
--- a/api/get-batchchange.html
+++ /dev/null
@@ -1,153 +0,0 @@
-VinylDNS: Get Batch Change
Pending - at least one change in batch in still in pending state; Complete - all changes are in complete state; Failed - all changes are in failure state; PartialFailure - some changes have failed and the rest are complete.
\ No newline at end of file
diff --git a/api/get-group.html b/api/get-group.html
deleted file mode 100644
index d25678a21..000000000
--- a/api/get-group.html
+++ /dev/null
@@ -1,119 +0,0 @@
-VinylDNS: Get Group
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
-
-
-
404
-
Not Found - The group was not found
-
-
-
-
-
HTTP RESPONSE ATTRIBUTES
-
-
-
-
-
name
-
type
-
description
-
-
-
-
-
id
-
string
-
Unique UUID of the group
-
-
-
name
-
map
-
The name of the group
-
-
-
email
-
string
-
The email distribution list of the group
-
-
-
description
-
string
-
The group description, the group may not have this field if it was not set
\ No newline at end of file
diff --git a/api/get-recordset-change.html b/api/get-recordset-change.html
deleted file mode 100644
index 18e0cc99e..000000000
--- a/api/get-recordset-change.html
+++ /dev/null
@@ -1,131 +0,0 @@
-VinylDNS: Get RecordSet Change
RecordSet changes (Create, Update, Delete) are not immediately applied to the DNS backend; they are queued up for processing. Most changes are applied within a few seconds.
-When you submit a change for processing, the response is a Change model. You can use the information in that change model in order to poll for the status of the change until it completes (status = Complete) or fails (status = Failed)
-
-
HTTP REQUEST
-
-
-
GET /zones/{zoneId}/recordsets/{recordSetId}/changes/{recordChangeId}
-
-
-
HTTP RESPONSE TYPES
-
-
-
-
-
Code
-
description
-
-
-
-
-
200
-
OK - The record set change is returned in the response body
-
-
-
401
-
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
-
-
-
403
-
Forbidden - The user does not have the access required to perform the action
-
-
-
404
-
Not Found - The zone, record set, or change was not found
-
-
-
-
-
HTTP RESPONSE ATTRIBUTES
-
-
-
-
-
name
-
type
-
description
-
-
-
-
-
zone
-
map
-
contains information about the zone when the change was created
-
-
-
recordSet
-
map
-
contains the recordset model
-
-
-
userId
-
string
-
the user id that initiated the change
-
-
-
changeType
-
string
-
type of change requested (Create, Update, or Delete)
-
-
-
created
-
string
-
the time (GMT) the change was initiated
-
-
-
id
-
string
-
the id of the change. This is not the id of the recordset
\ No newline at end of file
diff --git a/api/get-recordset.html b/api/get-recordset.html
deleted file mode 100644
index 51e3fe267..000000000
--- a/api/get-recordset.html
+++ /dev/null
@@ -1,136 +0,0 @@
-VinylDNS: Get RecordSet
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
-
-
-
403
-
Forbidden - The user does not have the access required to perform the action
-
-
-
404
-
Not Found - The zone with the id specified was not found, or the record set with id was not found
-
-
-
-
-
HTTP RESPONSE ATTRIBUTES
-
The returned json object has all the fields from the RecordSet as well as an added accessLevel field
-
-
-
-
-
name
-
type
-
description
-
-
-
-
-
type
-
string
-
type of record set
-
-
-
zoneId
-
string
-
the zone the record is stored in
-
-
-
name
-
string
-
the name of the record set
-
-
-
ttl
-
integer
-
the TTL of the record set in seconds
-
-
-
status
-
string
-
the status of the record set
-
-
-
created
-
string
-
the time (GMT) the change was initiated
-
-
-
updated
-
string
-
the time (GMT) the change was last updated
-
-
-
records
-
array of record data
-
array of record data objects
-
-
-
id
-
string
-
the unique id of the record set
-
-
-
account
-
string
-
DEPRECATED the id of the account that created the record set
-
-
-
accessLevel
-
string
-
accessLevel that user has to record set based off acl rules and whether or not user is in Zone Admin Group
\ No newline at end of file
diff --git a/api/get-zone.html b/api/get-zone.html
deleted file mode 100644
index 63e7ed726..000000000
--- a/api/get-zone.html
+++ /dev/null
@@ -1,95 +0,0 @@
-VinylDNS: Get Zone
OK - Successful lookup, the zone is returned in the response body
-
-
-
401
-
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
-
-
-
403
-
Forbidden - The user does not have the access required to perform the action
\ No newline at end of file
diff --git a/api/index.html b/api/index.html
deleted file mode 100644
index fdcf9b425..000000000
--- a/api/index.html
+++ /dev/null
@@ -1,15 +0,0 @@
-VinylDNS: API documentation
\ No newline at end of file
diff --git a/api/list-batchchanges.html b/api/list-batchchanges.html
deleted file mode 100644
index dd7fdd95d..000000000
--- a/api/list-batchchanges.html
+++ /dev/null
@@ -1,144 +0,0 @@
-VinylDNS: List Batch Changes
Retrieves the most recent 100 batch changes created by the user. This call will return a subset of the full information in each change, as detailed in the attributes section.
-
-
The max number of batch changes that are returned from a single request has been set to 100.
-
-
HTTP REQUEST
-
-
-
GET zones/batchrecordchanges
-
-
-
HTTP RESPONSE TYPES
-
-
-
-
-
Code
-
description
-
-
-
-
-
200
-
OK - the batch change is returned in response body.
-
-
-
403
-
Forbidden - the user does not have the access required to perform the action.
-
-
-
-
-
If there are no batch changes created by the user, a successful empty response body is returned.
Summary information for the most recent 100 batch changes created by the user.
-
-
-
-
-
BatchChangeSummary
-
-
-
-
-
name
-
type
-
description
-
-
-
-
-
userId
-
string
-
The unique identifier of the user that created the batch change.
-
-
-
userName
-
string
-
The username of the user that created the batch change.
-
-
-
comments
-
date-time
-
Optional comments about the batch change.
-
-
-
createdTimestamp
-
date-time
-
The timestamp (in GMT) when the batch change was created.
-
-
-
totalChanges
-
int
-
The total number of single changes within the batch change.
-
-
-
status
-
BatchChangeStatus
-
Pending - at least one change in batch in still in pending state; Complete - all changes are in complete state; Failed - all changes are in failure state; PartialFailure - some changes have failed and the rest are complete.
\ No newline at end of file
diff --git a/api/list-group-activity.html b/api/list-group-activity.html
deleted file mode 100644
index 4049165d2..000000000
--- a/api/list-group-activity.html
+++ /dev/null
@@ -1,196 +0,0 @@
-VinylDNS: List Group Activity
GET /groups/{groupId}/activity?startFrom={response.nextId}&maxItems={1 - 100}
-
-
-
HTTP REQUEST PARAMS
-
-
-
-
-
name
-
type
-
required?
-
description
-
-
-
-
-
startFrom
-
any
-
no
-
In order to advance through pages of results, the startFrom is set to the nextId that is returned on the previous response. It is up to the client to maintain previous pages if the client wishes to advance forward and backward. If not specified, will return the first page of results
-
-
-
maxItems
-
integer
-
no
-
The number of items to return in the page. Valid values are 1 to 100. Defaults to 100 if not provided.
-
-
-
-
-
HTTP RESPONSE TYPES
-
-
-
-
-
Code
-
description
-
-
-
-
-
200
-
OK - The changes have been returned in the response body
-
-
-
401
-
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
\ No newline at end of file
diff --git a/api/list-group-admins.html b/api/list-group-admins.html
deleted file mode 100644
index 44a478bee..000000000
--- a/api/list-group-admins.html
+++ /dev/null
@@ -1,84 +0,0 @@
-VinylDNS: List Group Admins
OK - The admins have been returned in the response body
-
-
-
401
-
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
\ No newline at end of file
diff --git a/api/list-group-members.html b/api/list-group-members.html
deleted file mode 100644
index b9331d8b7..000000000
--- a/api/list-group-members.html
+++ /dev/null
@@ -1,129 +0,0 @@
-VinylDNS: List Group Members
GET /groups/{groupId}/members?startFrom={response.nextId}&maxItems={1 - 100}
-
-
-
HTTP REQUEST PARAMS
-
-
-
-
-
name
-
type
-
required?
-
description
-
-
-
-
-
startFrom
-
any
-
no
-
In order to advance through pages of results, the startFrom is set to the nextId that is returned on the previous response. It is up to the client to maintain previous pages if the client wishes to advance forward and backward. If not specified, will return the first page of results
-
-
-
maxItems
-
integer
-
no
-
The number of items to return in the page. Valid values are 1 to 100. Defaults to 100 if not provided.
-
-
-
-
-
HTTP RESPONSE TYPES
-
-
-
-
-
Code
-
description
-
-
-
-
-
200
-
OK - The members have been returned in the response body
-
-
-
401
-
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
-
-
-
404
-
Not Found - The group was not found
-
-
-
-
-
HTTP RESPONSE ATTRIBUTES
-
-
-
-
-
name
-
type
-
description
-
-
-
-
-
members
-
Array of Users
-
refer to membership model, these Users will also include an isAdmin attribute
-
-
-
startFrom
-
any
-
startFrom sent in request, will not be returned if not provided
-
-
-
nextId
-
any
-
nextId, used as startFrom parameter of next page request, will not be returned if members are exhausted
\ No newline at end of file
diff --git a/api/list-groups.html b/api/list-groups.html
deleted file mode 100644
index 2d55b6d48..000000000
--- a/api/list-groups.html
+++ /dev/null
@@ -1,152 +0,0 @@
-VinylDNS: List Groups
GET /groups?startFrom={response.nextId}&maxItems={1 - 100}&groupNameFilter={filter}
-
-
-
HTTP REQUEST PARAMS
-
-
-
-
-
name
-
type
-
required?
-
description
-
-
-
-
-
groupNameFilter
-
string
-
no
-
One or more characters contained in the name of the group set to search for. For example TP. This is a contains search only, no wildcards or regular expressions are supported
-
-
-
startFrom
-
any
-
no
-
In order to advance through pages of results, the startFrom is set to the nextId that is returned on the previous response. It is up to the client to maintain previous pages if the client wishes to advance forward and backward. If not specified, will return the first page of results
-
-
-
maxItems
-
integer
-
no
-
The number of items to return in the page. Valid values are 1 to 100. Defaults to 100 if not provided.
-
-
-
-
-
HTTP RESPONSE TYPES
-
-
-
-
-
Code
-
description
-
-
-
-
-
200
-
OK - The groups have been returned in the response body
-
-
-
401
-
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
\ No newline at end of file
diff --git a/api/list-recordset-changes.html b/api/list-recordset-changes.html
deleted file mode 100644
index 4edd83526..000000000
--- a/api/list-recordset-changes.html
+++ /dev/null
@@ -1,594 +0,0 @@
-VinylDNS: List RecordSet Changes
RecordSet changes (Create, Update, Delete) are not immediately applied to the DNS backend; they are queued up for processing. Most changes are applied within a few seconds.
-When you submit a change for processing, the response is a Change model. You can use the information in that change model in order to poll for the status of the change until it completes (status = Complete) or fails (status = Failed)
-
-Retrieves a list of RecordSet changes in a zone. All RecordSet changes are stored, including those coming from zone syncs. RecordSet changes come in max page sizes of 100 changes, paging must be done independently using startFrom and nextId parameters
-
-
HTTP REQUEST
-
-
-
GET /zones/{zoneId}/recordsetchanges?startFrom={response.nextId}&maxItems={1 - 100}
-
-
-
HTTP REQUEST PARAMS
-
-
-
-
-
name
-
type
-
required?
-
description
-
-
-
-
-
startFrom
-
any
-
no
-
In order to advance through pages of results, the startFrom is set to the nextId that is returned on the previous response. It is up to the client to maintain previous pages if the client wishes to advance forward and backward. If not specified, will return the first page of results
-
-
-
maxItems
-
int
-
no
-
The number of items to return in the page. Valid values are 1 - 100. Defaults to 100 if not provided.
-
-
-
-
-
HTTP RESPONSE TYPES
-
-
-
-
-
Code
-
description
-
-
-
-
-
200
-
OK - the recordset changes are returned in response body
-
-
-
401
-
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
-
-
-
403
-
Forbidden - The user does not have the access required to perform the action
-
-
-
404
-
Not Found - Zone not found
-
-
-
-
-
HTTP RESPONSE ATTRIBUTES
-
-
-
-
-
name
-
type
-
description
-
-
-
-
-
zoneId
-
string
-
Id of zone used for request
-
-
-
recordSetChanges
-
array of recordset changes
-
array of recordset changes sorted by created time in descending order
-
-
-
startFrom
-
any
-
(optional) The startFrom parameter that was sent in on the HTTP request. Will not be present if the startFrom parameter was not sent
-
-
-
nextId
-
any
-
(optional) The identifier to be passed in as the startFrom parameter to retrieve the next page of results. If there are no results left, this field will not be present
-
-
-
maxItems
-
int
-
The maxItems parameter that was sent in on the HTTP request. This will be 100 if not sent
\ No newline at end of file
diff --git a/api/list-recordsets.html b/api/list-recordsets.html
deleted file mode 100644
index 69bfb8667..000000000
--- a/api/list-recordsets.html
+++ /dev/null
@@ -1,232 +0,0 @@
-VinylDNS: List / Search RecordSets
GET /zones/{zoneId}/recordsets?startFrom={response.nextId}&maxItems={1 - 100}&recordNameFilter={filter}
-
-
-
HTTP REQUEST PARAMS
-
-
-
-
-
name
-
type
-
required?
-
description
-
-
-
-
-
recordNameFilter
-
string
-
no
-
One or more characters contained in the name of the record set to search for. For example vinyl. This is a contains search only, no wildcards or regular expressions are supported
-
-
-
startFrom
-
any
-
no
-
In order to advance through pages of results, the startFrom is set to the nextId that is returned on the previous response. It is up to the client to maintain previous pages if the client wishes to advance forward and backward. If not specified, will return the first page of results
-
-
-
maxItems
-
integer
-
no
-
The number of items to return in the page. Valid values are 1 to 100. Defaults to 100 if not provided.
-
-
-
-
-
HTTP RESPONSE TYPES
-
-
-
-
-
Code
-
description
-
-
-
-
-
200
-
OK - The record sets are returned in the response body
-
-
-
401
-
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
-
-
-
403
-
Forbidden - The user does not have the access required to perform the action
-
-
-
404
-
Not Found - Zone or RecordSet not found
-
-
-
-
-
HTTP RESPONSE ATTRIBUTES
-
-
-
-
-
name
-
type
-
description
-
-
-
-
-
recordSets
-
Array of RecordSets
-
refer to recordset model, the RecordSet data will also include the accessLevel the requesting user has based off acl rules and membership in Zone Admin Group
-
-
-
startFrom
-
any
-
startFrom sent in request, will not be returned if not provided
-
-
-
nextId
-
any
-
nextId, used as startFrom parameter of next page request, will not be returned if record sets are exhausted
\ No newline at end of file
diff --git a/api/list-zone-changes.html b/api/list-zone-changes.html
deleted file mode 100644
index 770f9a8c0..000000000
--- a/api/list-zone-changes.html
+++ /dev/null
@@ -1,164 +0,0 @@
-VinylDNS: List Zone Changes
Retrieves a list of zone changes to a zone. All zone changes are stored, including those coming from zone syncs. Zone changes come in max page sizes of 100 changes, paging must be done independently using startFrom and nextId parameters
-
-
HTTP REQUEST
-
-
-
GET /zones/{zoneId}/changes?startFrom={response.nextId}&maxItems={1 - 100}
-
-
-
HTTP REQUEST PARAMS
-
-
-
-
-
name
-
type
-
required?
-
description
-
-
-
-
-
startFrom
-
any
-
no
-
In order to advance through pages of results, the startFrom is set to the nextId that is returned on the previous response. It is up to the client to maintain previous pages if the client wishes to advance forward and backward. If not specified, will return the first page of results
-
-
-
maxItems
-
int
-
no
-
The number of items to return in the page. Valid values are 1 - 100. Defaults to 100 if not provided.
-
-
-
-
-
HTTP RESPONSE TYPES
-
-
-
-
-
Code
-
description
-
-
-
-
-
200
-
Accepted - The zone changes will be returned in the response body
-
-
-
401
-
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
-
-
-
403
-
Forbidden - The user does not have the access required to perform the action
-
-
-
404
-
Not Found - Zone not found
-
-
-
-
-
HTTP RESPONSE ATTRIBUTES
-
-
-
-
-
name
-
type
-
description
-
-
-
-
-
zoneId
-
string
-
Id of zone used for request
-
-
-
zoneChanges
-
array of zone changes
-
array of zone changes sorted by created time in descending order
-
-
-
startFrom
-
any
-
(optional) The startFrom parameter that was sent in on the HTTP request. Will not be present if the startFrom parameter was not sent
-
-
-
nextId
-
any
-
(optional) The identifier to be passed in as the startFrom parameter to retrieve the next page of results. If there are no results left, this field will not be present
-
-
-
maxItems
-
int
-
The maxItems parameter that was sent in on the HTTP request. This will be 100 if not sent
\ No newline at end of file
diff --git a/api/list-zones.html b/api/list-zones.html
deleted file mode 100644
index 715a2d88e..000000000
--- a/api/list-zones.html
+++ /dev/null
@@ -1,182 +0,0 @@
-VinylDNS: List / Search Zones
Retrieves the list of zones a user has access to. The zone name is only sorted alphabetically.
-
-
HTTP REQUEST
-
-
-
GET /zones?nameFilter={yoursearchhere}&startFrom={response.nextId}&maxItems={1 - 100}
-
-
-
HTTP REQUEST PARAMS
-
-
-
-
-
name
-
type
-
required?
-
description
-
-
-
-
-
nameFilter
-
string
-
no
-
One or more characters contained in the name of the zone to search for. For example www-. This is a contains search only, no wildcards or regular expressions are supported
-
-
-
startFrom
-
any
-
no
-
In order to advance through pages of results, the startFrom is set to the nextId that is returned on the previous response. It is up to the client to maintain previous pages if the client wishes to advance forward and backward. If not specified, will return the first page of results
-
-
-
maxItems
-
int
-
no
-
The number of items to return in the page. Valid values are 1 - 100. Defaults to 100 if not provided.
-
-
-
-
-
HTTP RESPONSE TYPES
-
-
-
-
-
Code
-
description
-
-
-
-
-
200
-
OK - The zones and search info are returned in response body
-
-
-
401
-
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
-
-
-
403
-
Forbidden - The user does not have the access required to perform the action
An array of the zones found. The zones are sorted alphabetically by zone name.
-
-
-
startFrom
-
any
-
(optional) The startFrom parameter that was sent in on the HTTP request. Will not be present if the startFrom parameter was not sent
-
-
-
nextId
-
any
-
(optional) The identifier to be passed in as the startFrom parameter to retrieve the next page of results. If there are no results left, this field will not be present.
-
-
-
maxItems
-
int
-
The maxItems parameter that was sent in on the HTTP request. This will be 100 if not sent.
\ No newline at end of file
diff --git a/api/membership-model.html b/api/membership-model.html
deleted file mode 100644
index 36a90d46e..000000000
--- a/api/membership-model.html
+++ /dev/null
@@ -1,166 +0,0 @@
-VinylDNS: Membership Model
Every zone can be connected to by only one group in VinylDNS. That initial group will be the admin group for that zone,
-which can be changed later on in a Zone Update. Every member of the admin group
-will be an admin of that zone, and can preform zone syncs, zone updates, zone deletes, and record set changes regardless
-of any Access Control Rules set on them.
-
-While users in the admin group will have complete zone access, further users can be given limited membership through Zone
-ACL Rules
-
-
GROUP ATTRIBUTES
-
-
-
-
-
field
-
type
-
description
-
-
-
-
-
name
-
string
-
This should be a single word name used for the groups. Use hyphens if needed, no spaces
-
-
-
email
-
string
-
The email distribution list for the group
-
-
-
description
-
string
-
A short description of the group, if more info is needed other than the name. The group will not have this attribute if it was not included in the create request
-
-
-
id
-
string
-
Unique UUID of the group
-
-
-
created
-
date-time
-
The timestamp GMT when the group was created
-
-
-
status
-
string
-
Active or Deleted
-
-
-
members
-
Array of User id objects
-
Set of User ids in the group
-
-
-
admins
-
Array of User id objects
-
Set of User ids that are admins of the group. All admin user ids should also be in the members array
-
-
-
-
-
Being in the admin set of a group has no impact on zone privileges when the group is the zone’s admin group. Being a group admin allows adding users to
-the group, deleting users from the group, toggling other users’ admin statuses (including your own), and deleting the group
\ No newline at end of file
diff --git a/api/recordset-model.html b/api/recordset-model.html
deleted file mode 100644
index b2ff9fa91..000000000
--- a/api/recordset-model.html
+++ /dev/null
@@ -1,351 +0,0 @@
-VinylDNS: RecordSet Model
the id of the zone to which this recordset belongs
-
-
-
name
-
string
-
The name of the RecordSet
-
-
-
type
-
string
-
Type of DNS record, supported records are currently: A, AAAA, CNAME, PTR, MX, NS, SOA, SRV, TXT, SSHFP, and SPF. Unsupported types will be given the type UNKNOWN
-
-
-
ttl
-
long
-
the TTL in seconds for the recordset
-
-
-
status
-
string
-
Active - RecordSet is added is created and ready for use, Inactive - RecordSet effects are not applied, Pending - RecordSet is queued for creation, PendingUpdate - RecordSet is queued for update, PendingDelete - RecordSet is queued for delete
-
-
-
created
-
date-time
-
the timestamp GMT when the recordset was created
-
-
-
updated
-
date-time
-
the timestamp GMT when the recordset was last updated
Current supported record types are: A, AAAA, CNAME, PTR, MX, NS, SOA, SRV, TXT, SSHFP, and SPF.
-Each individual record encodes its data in a record data object, in which each record type has different required attributes
-
-NS and SOA records are currently read-only and cannot be created, updated or deleted
-
-
-
-
-
record type
-
attribute
-
type
-
-
-
-
-
A
-
address
-
string
-
-
-
-
-
-
-
-
AAAA
-
address
-
string
-
-
-
-
-
-
-
-
CNAME
-
cname
-
string
-
-
-
-
-
-
-
-
MX
-
preference
-
integer
-
-
-
MX
-
exchange
-
string
-
-
-
-
-
-
-
-
NS
-
nsdname
-
string
-
-
-
-
-
-
-
-
PTR
-
ptrdname
-
string
-
-
-
-
-
-
-
-
SOA
-
mname
-
string
-
-
-
SOA
-
rname
-
string
-
-
-
SOA
-
serial
-
long
-
-
-
SOA
-
refresh
-
long
-
-
-
SOA
-
retry
-
long
-
-
-
SOA
-
expire
-
long
-
-
-
SOA
-
minimum
-
long
-
-
-
-
-
-
-
-
SPF
-
text
-
string
-
-
-
-
-
-
-
-
SRV
-
priority
-
integer
-
-
-
SRV
-
weight
-
integer
-
-
-
SRV
-
port
-
integer
-
-
-
SRV
-
target
-
string
-
-
-
-
-
-
-
-
SSHFP
-
algorithm
-
integer
-
-
-
SSHFP
-
typ
-
integer
-
-
-
SSHFP
-
fingerprint
-
string
-
-
-
-
-
-
-
-
TXT
-
text
-
string
-
-
-
-
-
RECORD DATA EXAMPLE
-
-
Each record is a map that must include all attributes for the data type, the records are stored in the records field of the RecordSet.
-The records must be an array of at least one record map. All records in the records array must be of the type stored in the typ field of the RecordSet
-
-
Use the @ symbol to point to the zone origin
-
-
CNAME records cannot point to the zone origin, thus the RecordSet name cannot be @ nor the zone origin
\ No newline at end of file
diff --git a/api/sync-zone.html b/api/sync-zone.html
deleted file mode 100644
index 9a5367acd..000000000
--- a/api/sync-zone.html
+++ /dev/null
@@ -1,137 +0,0 @@
-VinylDNS: Sync Zone
Used to sync VinylDNS zone info with existing zone info. When a sync is performed, a zone transfer is initiated with the backend DNS server.
-The backend data is compared to the existing data in VinylDNS. If there are any differences, the backend DNS Server is considered
-the source of truth and will overwrite the data in VinylDNS. All changes will be recorded in VinylDNS so they can be seen in the
-zone history.
-
-
While the zone is syncing, the zone will be unavailable for updates (read-only).
-
-
We have done some testing on how long syncs take. These will vary with usage:
-
-
-
1000 records ~ 1 second
-
10,000 records ~ 10 seconds
-
100,000 records ~ 6 minutes
-
-
-
Please keep these numbers in mind when you perform syncs.
-
-
HTTP REQUEST
-
-
-
POST /zones/{zoneId}/sync
-
-
-
HTTP RESPONSE TYPES
-
-
-
-
-
Code
-
description
-
-
-
-
-
200
-
OK - Successful lookup, the zone is returned in the response body
-
-
-
400
-
Bad Request - invalid sync state, a sync has been performed recently, or zone is inactive
-
-
-
401
-
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
-
-
-
403
-
Forbidden - the user does not have the access required to perform the action
\ No newline at end of file
diff --git a/api/update-group.html b/api/update-group.html
deleted file mode 100644
index 6053ea001..000000000
--- a/api/update-group.html
+++ /dev/null
@@ -1,219 +0,0 @@
-VinylDNS: Update Group
OK - The group has been updated and the group info is returned in the response body
-
-
-
400
-
Bad Request - The group was invalid or a user id was not found
-
-
-
401
-
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
-
-
-
403
-
Forbidden - The user does not have the access required to perform the action
-
-
-
404
-
Not Found - The group was not found
-
-
-
409
-
Conflict - The group already exists
-
-
-
-
-
HTTP RESPONSE ATTRIBUTES
-
-
-
-
-
name
-
type
-
description
-
-
-
-
-
id
-
string
-
Unique UUID of the group
-
-
-
name
-
map
-
The name of the group
-
-
-
email
-
string
-
The email distribution list of the group
-
-
-
description
-
string
-
The group description, the group will not have this attribute if it was not included in the update request and already did not exist
Accepted - the update is valid and has been accepted for processing; the record set change resource is returned in the response body
-
-
-
400
-
Bad Request - the zone being updated is not active; typically because the connection information does not exist for the zone
-
-
-
401
-
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
-
-
-
403
-
Forbidden - The user does not have the access required to perform the action
-
-
-
404
-
Not Found - Zone or RecordSet not found
-
-
-
409
-
Conflict - There is an existing pending change against this record set
-
-
-
422
-
Unprocessable Entity
-
-
-
-
-
HTTP RESPONSE ATTRIBUTES
-
-
-
-
-
name
-
type
-
description
-
-
-
-
-
zone
-
map
-
contains information about the zone when the change was created
-
-
-
recordSet
-
map
-
contains the recordset model
-
-
-
updates
-
map
-
new data to overwrite current record set
-
-
-
userId
-
string
-
the user id that initiated the change
-
-
-
changeType
-
string
-
type of change requested (Create, Update, Delete); in this case Update
-
-
-
created
-
string
-
the time (GMT) the change was initiated
-
-
-
id
-
string
-
the id of the change. This is not the id of the recordset
\ No newline at end of file
diff --git a/api/update-zone.html b/api/update-zone.html
deleted file mode 100644
index e72966593..000000000
--- a/api/update-zone.html
+++ /dev/null
@@ -1,156 +0,0 @@
-VinylDNS: Update Zone
Accepted - The zone change is returned in the response body
-
-
-
400
-
Bad Request - connection failed
-
-
-
401
-
Unauthorized - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect
-
-
-
403
-
Forbidden - the user does not have the access required to perform the action
-
-
-
404
-
Not Found - Zone not found
-
-
-
409
-
Conflict - Zone has a pending update
-
-
-
-
-
HTTP RESPONSE ATTRIBUTES
-
-
-
-
-
name
-
type
-
description
-
-
-
-
-
zone
-
map
-
zone sent with update request, refer to zone model
-
-
-
userId
-
string
-
the user id that initiated the change
-
-
-
changeType
-
string
-
type of change requested (Create, Update, Sync, Delete); in this case Update
-
-
-
created
-
string
-
the time (GMT) the change was initiated
-
-
-
id
-
string
-
the id of the change. This is not the id of the zone
\ No newline at end of file
diff --git a/api/zone-model.html b/api/zone-model.html
deleted file mode 100644
index a83670da3..000000000
--- a/api/zone-model.html
+++ /dev/null
@@ -1,370 +0,0 @@
-VinylDNS: Zone Model
Active - the zone is connected and ready for use; Syncing - the zone is currently syncing with the DNS backend and is not available until syncing is complete.
-
-
-
updated
-
date-time
-
The last time the zone was changed. Note: this does not include changes to record sets, only the zone entity itself
-
-
-
name
-
string
-
The name of the zone
-
-
-
adminGroupId
-
string
-
The id of the administrators group for the zone
-
-
-
created
-
date-time
-
The time when the zone was first created
-
-
-
account
-
string
-
DEPRECATED The account that created the zone
-
-
-
email
-
string
-
The distribution email for the zone
-
-
-
connection
-
ZoneConnection
-
The connection used to issue DDNS updates to the backend zone. If not provided, default keys will be used. See the Zone Connection Attributes for more information
-
-
-
transferConnection
-
ZoneConnection
-
The connection that is used to sync the zone with the DNS backend. This can be different than the update connection. If not provided, default keys will be used
-
-
-
shared
-
boolean
-
DEPRECATED An indicator that the zone is shared with anyone. No longer used as ACLs are now used to manage zones.
-
-
-
acl
-
ZoneACL
-
The access control rules governing the zone. See the Zone ACL Rule Attributes for more information
Zone Connection specifies the connection information to the backend DNS server.
-
-
-
-
-
field
-
type
-
description
-
-
-
-
-
primaryServer
-
string
-
The ip address or host that is connected to. This can take a port as well 127.0.0.1:5300. If no port is specified, 53 will be assumed.
-
-
-
keyName
-
string
-
The name of the DNS key that has access to the DNS server and zone. Note: For the transfer connection, the key must be given allow-transfer access to the zone. For the primary connection, the key must be given allow-update access to the zone.
-
-
-
name
-
string
-
A user identifier for the connection.
-
-
-
key
-
string
-
The TSIG secret key used to sign requests when communicating with the primary server. Note: After creating the zone, the key value itself is hashed and obfuscated, so it will be unusable from a client perspective.
ACL Rules are used to govern user and group access to record operations on a zone. ACL Rules can be associated with a specific user, or all users in a specified group. If neither a user or a group is attached to an ACL rule, then the rule applies to all users in the system.
-
-Use the Zone Update endpoint to update the acl attribute of the zone
-
-
-
Important! If a user is mentioned on an ACL Rule directly, or is a member of a group that is mentioned on an ACL Rule, that user will be able to see the zone.
-
-
-
-
Rules made without selecting a group or user will apply to all users in VinylDNS.
-
-
-
-
-
-
field
-
type
-
description
-
-
-
-
-
recordMask
-
string
-
(optional) A regular expression that is used to match against record names. If left empty, then all records will be matched for the rule. All records matching the match will be governed by this rule.
-
-
-
recordTypes
-
Array[String]
-
An array of all record types that this rule applies to. If left empty, then all record types will be governed by this rule.
-
-
-
accessLevel
-
string
-
NoAccess - cannot see the data for the record; Read - can read only the record; Write - the user can create and edit records, but cannot delete them; Delete - the user can read, create, update, and delete records
-
-
-
userId
-
string
-
(optional) The unique identifier for the user the rule applies to. Note: this is not the name of the user, but their uuid in VinylDNS
-
-
-
groupId
-
string
-
(optional) The unique identifier for the group the rule applies to. Note: you cannot set both the userId and groupId, only one
-
-
-
description
-
string
-
(optional) A user entered description for the rule
-
-
-
-
-
The priority of ACL Rules in descending precedence:
-
-
Individual rules placed on a user
-
Rules placed on groups that a user is in
-
Rules placed on all users in VinylDNS
-
-
-
-
Note: Being in the admin group of a zone will grant users full access regardless of ACL Rules
-
-
-
For conflicting rules, the rule that is more specific will take precedence. For example, if the account jdoe201 was given Read access to all records in a zone
-through the rule:
then the rule with the recordMask will take precedence and give Delete access to matched A RecordSets, the rule with recordTypes will
-take precedence and give Write access to all other A records, and the more broad rule will give Read access to all other record types in the zone
-
-
ZONE ACL RULE EXAMPLES
-
Grant read/write/delete access to www.* records of type A, AAAA, CNAME to one user
-Under this rule, the user specified will be able to view, create, edit, and delete records in the zone that match the expression www.* and are of type A, AAAA, or CNAME.
Acl rules can be applied to specific record types and can include record masks to further narrow down which records they
-apply to. These record masks apply to record names, but because PTR record names are part their reverse zone ip, the use of regular
-expressions for record masks are not supported.
-
-Instead PTR record masks must be CIDR rules, which will denote a range of ip addresses that the rule will apply to.
-While more information and useful CIDR rule utility tools can be found online, CIDR rules describe how many bits of an ip address’ binary representation
-must be the same for a match.
Will give Read permissions to PTR Record Sets 1000:1000:1000:1000:0000:0000:0000:0000 to 1000:1000:1000:1000:FFFF:FFFF:FFFF:FFFF, as 64 bits is half of an IPv6 address
-
` tags are not being overridden anymore
-- More correct highlighting of code blocks inside non-`
` containers:
- highlighter now doesn't insist on replacing them with its own container and
- just replaces the contents.
-- Small fixes in browser compatibility and heuristics.
-
-[c++ 0x]: http://ru.wikipedia.org/wiki/C%2B%2B0x
-[html 5]: http://en.wikipedia.org/wiki/HTML5
-[ik]: http://kalnitsky.org.ua/
-
-### For developers
-
-The most significant change is the ability to include language submodes right
-under `contains` instead of defining explicit named submodes in the main array:
-
- contains: [
- 'string',
- 'number',
- {begin: '\\n', end: hljs.IMMEDIATE_RE}
- ]
-
-This is useful for auxiliary modes needed only in one place to define parsing.
-Note that such modes often don't have `className` and hence won't generate a
-separate `` in the resulting markup. This is similar in effect to
-`noMarkup: true`. All existing languages have been refactored accordingly.
-
-Test file test.html has at last become a real test. Now it not only puts the
-detected language name under the code snippet but also tests if it matches the
-expected one. Test summary is displayed right above all language snippets.
-
-
-## CDN
-
-Fine people at [Yandex][] agreed to host highlight.js on their big fast servers.
-[Link up][l]!
-
-[yandex]: http://yandex.com/
-[l]: http://softwaremaniacs.org/soft/highlight/en/download/
-
-
-## Version 5.10 — "Paris".
-
-Though I'm on a vacation in Paris, I decided to release a new version with a
-couple of small fixes:
-
-- Tomas Vitvar discovered that TAB replacement doesn't always work when used
- with custom markup in code
-- SQL parsing is even more rigid now and doesn't step over SmallTalk in tests
-
-
-## Version 5.9
-
-A long-awaited version is finally released.
-
-New languages:
-
-- Andrew Fedorov made a definition for Lua
-- a long-time highlight.js contributor [Peter Leonov][pl] made a definition for
- Nginx config
-- [Vladimir Moskva][vm] made a definition for TeX
-
-[pl]: http://kung-fu-tzu.ru/
-[vm]: http://fulc.ru/
-
-Fixes for existing languages:
-
-- [Loren Segal][ls] reworked the Ruby definition and added highlighting for
- [YARD][] inline documentation
-- the definition of SQL has become more solid and now it shouldn't be overly
- greedy when it comes to language detection
-
-[ls]: http://gnuu.org/
-[yard]: http://yardoc.org/
-
-The highlighter has become more usable as a library allowing to do highlighting
-from initialization code of JS frameworks and in ajax methods (see.
-readme.eng.txt).
-
-Also this version drops support for the [WordPress][wp] plugin. Everyone is
-welcome to [pick up its maintenance][p] if needed.
-
-[wp]: http://wordpress.org/
-[p]: http://bazaar.launchpad.net/~isagalaev/+junk/highlight/annotate/342/src/wp_highlight.js.php
-
-
-## Version 5.8
-
-- Jan Berkel has contributed a definition for Scala. +1 to hotness!
-- All CSS-styles are rewritten to work only inside `
` tags to avoid
- conflicts with host site styles.
-
-
-## Version 5.7.
-
-Fixed escaping of quotes in VBScript strings.
-
-
-## Version 5.5
-
-This version brings a small change: now .ini-files allow digits, underscores and
-square brackets in key names.
-
-
-## Version 5.4
-
-Fixed small but upsetting bug in the packer which caused incorrect highlighting
-of explicitly specified languages. Thanks to Andrew Fedorov for precise
-diagnostics!
-
-
-## Version 5.3
-
-The version to fulfil old promises.
-
-The most significant change is that highlight.js now preserves custom user
-markup in code along with its own highlighting markup. This means that now it's
-possible to use, say, links in code. Thanks to [Vladimir Dolzhenko][vd] for the
-[initial proposal][1] and for making a proof-of-concept patch.
-
-Also in this version:
-
-- [Vasily Polovnyov][vp] has sent a GitHub-like style and has implemented
- support for CSS @-rules and Ruby symbols.
-- Yura Zaripov has sent two styles: Brown Paper and School Book.
-- Oleg Volchkov has sent a definition for [Parser 3][p3].
-
-[1]: http://softwaremaniacs.org/forum/highlightjs/6612/
-[p3]: http://www.parser.ru/
-[vp]: http://vasily.polovnyov.ru/
-[vd]: http://dolzhenko.blogspot.com/
-
-
-## Version 5.2
-
-- at last it's possible to replace indentation TABs with something sensible
- (e.g. 2 or 4 spaces)
-- new keywords and built-ins for 1C by Sergey Baranov
-- a couple of small fixes to Apache highlighting
-
-
-## Version 5.1
-
-This is one of those nice version consisting entirely of new and shiny
-contributions!
-
-- [Vladimir Ermakov][vooon] created highlighting for AVR Assembler
-- [Ruslan Keba][rukeba] created highlighting for Apache config file. Also his
- original visual style for it is now available for all highlight.js languages
- under the name "Magula".
-- [Shuen-Huei Guan][drake] (aka Drake) sent new keywords for RenderMan
- languages. Also thanks go to [Konstantin Evdokimenko][ke] for his advice on
- the matter.
-
-[vooon]: http://vehq.ru/about/
-[rukeba]: http://rukeba.com/
-[drake]: http://drakeguan.org/
-[ke]: http://k-evdokimenko.moikrug.ru/
-
-
-## Version 5.0
-
-The main change in the new major version of highlight.js is a mechanism for
-packing several languages along with the library itself into a single compressed
-file. Now sites using several languages will load considerably faster because
-the library won't dynamically include additional files while loading.
-
-Also this version fixes a long-standing bug with Javascript highlighting that
-couldn't distinguish between regular expressions and division operations.
-
-And as usually there were a couple of minor correctness fixes.
-
-Great thanks to all contributors! Keep using highlight.js.
-
-
-## Version 4.3
-
-This version comes with two contributions from [Jason Diamond][jd]:
-
-- language definition for C# (yes! it was a long-missed thing!)
-- Visual Studio-like highlighting style
-
-Plus there are a couple of minor bug fixes for parsing HTML and XML attributes.
-
-[jd]: http://jason.diamond.name/weblog/
-
-
-## Version 4.2
-
-The biggest news is highlighting for Lisp, courtesy of Vasily Polovnyov. It's
-somewhat experimental meaning that for highlighting "keywords" it doesn't use
-any pre-defined set of a Lisp dialect. Instead it tries to highlight first word
-in parentheses wherever it makes sense. I'd like to ask people programming in
-Lisp to confirm if it's a good idea and send feedback to [the forum][f].
-
-Other changes:
-
-- Smalltalk was excluded from DEFAULT_LANGUAGES to save traffic
-- [Vladimir Epifanov][voldmar] has implemented javascript style switcher for
- test.html
-- comments now allowed inside Ruby function definition
-- [MEL][] language from [Shuen-Huei Guan][drake]
-- whitespace now allowed between `
` and ``
-- better auto-detection of C++ and PHP
-- HTML allows embedded VBScript (`<% .. %>`)
-
-[f]: http://softwaremaniacs.org/forum/highlightjs/
-[voldmar]: http://voldmar.ya.ru/
-[mel]: http://en.wikipedia.org/wiki/Maya_Embedded_Language
-[drake]: http://drakeguan.org/
-
-
-## Version 4.1
-
-Languages:
-
-- Bash from Vah
-- DOS bat-files from Alexander Makarov (Sam)
-- Diff files from Vasily Polovnyov
-- Ini files from myself though initial idea was from Sam
-
-Styles:
-
-- Zenburn from Vladimir Epifanov, this is an imitation of a
- [well-known theme for Vim][zenburn].
-- Ascetic from myself, as a realization of ideals of non-flashy highlighting:
- just one color in only three gradations :-)
-
-In other news. [One small bug][bug] was fixed, built-in keywords were added for
-Python and C++ which improved auto-detection for the latter (it was shame that
-[my wife's blog][alenacpp] had issues with it from time to time). And lastly
-thanks go to Sam for getting rid of my stylistic comments in code that were
-getting in the way of [JSMin][].
-
-[zenburn]: http://en.wikipedia.org/wiki/Zenburn
-[alenacpp]: http://alenacpp.blogspot.com/
-[bug]: http://softwaremaniacs.org/forum/viewtopic.php?id=1823
-[jsmin]: http://code.google.com/p/jsmin-php/
-
-
-## Version 4.0
-
-New major version is a result of vast refactoring and of many contributions.
-
-Visible new features:
-
-- Highlighting of embedded languages. Currently is implemented highlighting of
- Javascript and CSS inside HTML.
-- Bundled 5 ready-made style themes!
-
-Invisible new features:
-
-- Highlight.js no longer pollutes global namespace. Only one object and one
- function for backward compatibility.
-- Performance is further increased by about 15%.
-
-Changing of a major version number caused by a new format of language definition
-files. If you use some third-party language files they should be updated.
-
-
-## Version 3.5
-
-A very nice version in my opinion fixing a number of small bugs and slightly
-increased speed in a couple of corner cases. Thanks to everybody who reports
-bugs in he [forum][f] and by email!
-
-There is also a new language — XML. A custom XML formerly was detected as HTML
-and didn't highlight custom tags. In this version I tried to make custom XML to
-be detected and highlighted by its own rules. Which by the way include such
-things as CDATA sections and processing instructions (``).
-
-[f]: http://softwaremaniacs.org/forum/viewforum.php?id=6
-
-
-## Version 3.3
-
-[Vladimir Gubarkov][xonix] has provided an interesting and useful addition.
-File export.html contains a little program that shows and allows to copy and
-paste an HTML code generated by the highlighter for any code snippet. This can
-be useful in situations when one can't use the script itself on a site.
-
-
-[xonix]: http://xonixx.blogspot.com/
-
-
-## Version 3.2 consists completely of contributions:
-
-- Vladimir Gubarkov has described SmallTalk
-- Yuri Ivanov has described 1C
-- Peter Leonov has packaged the highlighter as a Firefox extension
-- Vladimir Ermakov has compiled a mod for phpBB
-
-Many thanks to you all!
-
-
-## Version 3.1
-
-Three new languages are available: Django templates, SQL and Axapta. The latter
-two are sent by [Dmitri Roudakov][1]. However I've almost entirely rewrote an
-SQL definition but I'd never started it be it from the ground up :-)
-
-The engine itself has got a long awaited feature of grouping keywords
-("keyword", "built-in function", "literal"). No more hacks!
-
-[1]: http://roudakov.ru/
-
-
-## Version 3.0
-
-It is major mainly because now highlight.js has grown large and has become
-modular. Now when you pass it a list of languages to highlight it will
-dynamically load into a browser only those languages.
-
-Also:
-
-- Konstantin Evdokimenko of [RibKit][] project has created a highlighting for
- RenderMan Shading Language and RenderMan Interface Bytestream. Yay for more
- languages!
-- Heuristics for C++ and HTML got better.
-- I've implemented (at last) a correct handling of backslash escapes in C-like
- languages.
-
-There is also a small backwards incompatible change in the new version. The
-function initHighlighting that was used to initialize highlighting instead of
-initHighlightingOnLoad a long time ago no longer works. If you by chance still
-use it — replace it with the new one.
-
-[RibKit]: http://ribkit.sourceforge.net/
-
-
-## Version 2.9
-
-Highlight.js is a parser, not just a couple of regular expressions. That said
-I'm glad to announce that in the new version 2.9 has support for:
-
-- in-string substitutions for Ruby -- `#{...}`
-- strings from from numeric symbol codes (like #XX) for Delphi
-
-
-## Version 2.8
-
-A maintenance release with more tuned heuristics. Fully backwards compatible.
-
-
-## Version 2.7
-
-- Nikita Ledyaev presents highlighting for VBScript, yay!
-- A couple of bugs with escaping in strings were fixed thanks to Mickle
-- Ongoing tuning of heuristics
-
-Fixed bugs were rather unpleasant so I encourage everyone to upgrade!
-
-
-## Version 2.4
-
-- Peter Leonov provides another improved highlighting for Perl
-- Javascript gets a new kind of keywords — "literals". These are the words
- "true", "false" and "null"
-
-Also highlight.js homepage now lists sites that use the library. Feel free to
-add your site by [dropping me a message][mail] until I find the time to build a
-submit form.
-
-[mail]: mailto:Maniac@SoftwareManiacs.Org
-
-
-## Version 2.3
-
-This version fixes IE breakage in previous version. My apologies to all who have
-already downloaded that one!
-
-
-## Version 2.2
-
-- added highlighting for Javascript
-- at last fixed parsing of Delphi's escaped apostrophes in strings
-- in Ruby fixed highlighting of keywords 'def' and 'class', same for 'sub' in
- Perl
-
-
-## Version 2.0
-
-- Ruby support by [Anton Kovalyov][ak]
-- speed increased by orders of magnitude due to new way of parsing
-- this same way allows now correct highlighting of keywords in some tricky
- places (like keyword "End" at the end of Delphi classes)
-
-[ak]: http://anton.kovalyov.net/
-
-
-## Version 1.0
-
-Version 1.0 of javascript syntax highlighter is released!
-
-It's the first version available with English description. Feel free to post
-your comments and question to [highlight.js forum][forum]. And don't be afraid
-if you find there some fancy Cyrillic letters -- it's for Russian users too :-)
-
-[forum]: http://softwaremaniacs.org/forum/viewforum.php?id=6
diff --git a/highlight/README.md b/highlight/README.md
deleted file mode 100644
index 9f76e6bd5..000000000
--- a/highlight/README.md
+++ /dev/null
@@ -1,150 +0,0 @@
-# Highlight.js
-
-[](https://travis-ci.org/isagalaev/highlight.js)
-
-Highlight.js is a syntax highlighter written in JavaScript. It works in
-the browser as well as on the server. It works with pretty much any
-markup, doesn’t depend on any framework and has automatic language
-detection.
-
-## Getting Started
-
-The bare minimum for using highlight.js on a web page is linking to the
-library along with one of the styles and calling
-[`initHighlightingOnLoad`][1]:
-
-```html
-
-
-
-```
-
-This will find and highlight code inside of `
` tags; it tries
-to detect the language automatically. If automatic detection doesn’t
-work for you, you can specify the language in the `class` attribute:
-
-```html
-
...
-```
-
-The list of supported language classes is available in the [class
-reference][2]. Classes can also be prefixed with either `language-` or
-`lang-`.
-
-To disable highlighting altogether use the `nohighlight` class:
-
-```html
-
...
-```
-
-## Custom Initialization
-
-When you need a bit more control over the initialization of
-highlight.js, you can use the [`highlightBlock`][3] and [`configure`][4]
-functions. This allows you to control *what* to highlight and *when*.
-
-Here’s an equivalent way to calling [`initHighlightingOnLoad`][1] using
-jQuery:
-
-```javascript
-$(document).ready(function() {
- $('pre code').each(function(i, block) {
- hljs.highlightBlock(block);
- });
-});
-```
-
-You can use any tags instead of `
` to mark up your code. If
-you don't use a container that preserve line breaks you will need to
-configure highlight.js to use the ` ` tag:
-
-```javascript
-hljs.configure({useBR: true});
-
-$('div.code').each(function(i, block) {
- hljs.highlightBlock(block);
-});
-```
-
-For other options refer to the documentation for [`configure`][4].
-
-
-## Web Workers
-
-You can run highlighting inside a web worker to avoid freezing the browser
-window while dealing with very big chunks of code.
-
-In your main script:
-
-```javascript
-addEventListener('load', function() {
- var code = document.querySelector('#code');
- var worker = new Worker('worker.js');
- worker.onmessage = function(event) { code.innerHTML = event.data; }
- worker.postMessage(code.textContent);
-})
-```
-
-In worker.js:
-
-```javascript
-onmessage = function(event) {
- importScripts('/highlight.pack.js');
- var result = self.hljs.highlightAuto(event.data);
- postMessage(result.value);
-}
-```
-
-
-## Getting the Library
-
-You can get highlight.js as a hosted, or custom-build, browser script or
-as a server module. Right out of the box the browser script supports
-both AMD and CommonJS, so if you wish you can use RequireJS or
-Browserify without having to build from source. The server module also
-works perfectly fine with Browserify, but there is the option to use a
-build specific to browsers rather than something meant for a server.
-Head over to the [download page][5] for all the options.
-
-**Don't link to GitHub directly.** The library is not supposed to work straight
-from the source, it requires building. If none of the pre-packaged options
-work for you refer to the [building documentation][6].
-
-**The CDN-hosted package doesn't have all the languages.** Otherwise it'd be
-too big. If you don't see the language you need in the ["Common" section][5],
-it can be added manually:
-
-```html
-
-```
-
-**On Almond.** You need to use the optimizer to give the module a name. For
-example:
-
-```
-r.js -o name=hljs paths.hljs=/path/to/highlight out=highlight.js
-```
-
-
-## License
-
-Highlight.js is released under the BSD License. See [LICENSE][7] file
-for details.
-
-## Links
-
-The official site for the library is at .
-
-Further in-depth documentation for the API and other topics is at
-.
-
-Authors and contributors are listed in the [AUTHORS.en.txt][8] file.
-
-[1]: http://highlightjs.readthedocs.io/en/latest/api.html#inithighlightingonload
-[2]: http://highlightjs.readthedocs.io/en/latest/css-classes-reference.html
-[3]: http://highlightjs.readthedocs.io/en/latest/api.html#highlightblock-block
-[4]: http://highlightjs.readthedocs.io/en/latest/api.html#configure-options
-[5]: https://highlightjs.org/download/
-[6]: http://highlightjs.readthedocs.io/en/latest/building-testing.html
-[7]: https://github.com/isagalaev/highlight.js/blob/master/LICENSE
-[8]: https://github.com/isagalaev/highlight.js/blob/master/AUTHORS.en.txt
diff --git a/highlight/README.ru.md b/highlight/README.ru.md
deleted file mode 100644
index ac481d071..000000000
--- a/highlight/README.ru.md
+++ /dev/null
@@ -1,142 +0,0 @@
-# Highlight.js
-
-Highlight.js — это инструмент для подсветки синтаксиса, написанный на JavaScript. Он работает
-и в браузере, и на сервере. Он работает с практически любой HTML разметкой, не
-зависит от каких-либо фреймворков и умеет автоматически определять язык.
-
-
-## Начало работы
-
-Минимум, что нужно сделать для использования highlight.js на веб-странице — это
-подключить библиотеку, CSS-стили и вызывать [`initHighlightingOnLoad`][1]:
-
-```html
-
-
-
-```
-
-Библиотека найдёт и раскрасит код внутри тегов `
`, попытавшись
-автоматически определить язык. Когда автоопределение не срабатывает, можно явно
-указать язык в атрибуте class:
-
-```html
-
...
-```
-
-Список поддерживаемых классов языков доступен в [справочнике по классам][2].
-Класс также можно предварить префиксами `language-` или `lang-`.
-
-Чтобы отключить подсветку для какого-то блока, используйте класс `nohighlight`:
-
-```html
-
...
-```
-
-## Инициализация вручную
-
-Чтобы иметь чуть больше контроля за инициализацией подсветки, вы можете
-использовать функции [`highlightBlock`][3] и [`configure`][4]. Таким образом
-можно управлять тем, *что* и *когда* подсвечивать.
-
-Вот пример инициализации, эквивалентной вызову [`initHighlightingOnLoad`][1], но
-с использованием jQuery:
-
-```javascript
-$(document).ready(function() {
- $('pre code').each(function(i, block) {
- hljs.highlightBlock(block);
- });
-});
-```
-
-Вы можете использовать любые теги разметки вместо `