Retrieves a list of aliases for the authenticated User or Team. When domain is provided, only aliases for that domain will be returned. When projectId is provided, it will only return the given project aliases.
643 matches
58 actions
Vercel
58 actions
- Create a DNS recordPOSTv1.0.0
- Create a new secretPOSTv1.0.0
- Create a TeamPOSTv1.0.0
- Create an Edge ConfigPOSTv1.0.0
- Create one or more environment variablesPOSTv1.0.0
- Creates a Configurable Log DrainPOSTv1.0.0
- Creates a new CheckPOSTv1.0.0
- Creates a new Integration Log DrainPOSTv1.0.0
- Delete a DeploymentDELETEv1.0.0
- Delete a ProjectDELETEv1.0.0
- Delete a secretDELETEv1.0.0
- Delete a TeamDELETEv1.0.0
- Delete an AliasDELETEv1.0.0
- Delete an Edge ConfigDELETEv1.0.0
- Delete an integration configurationDELETEv1.0.0
- Deletes a Configurable Log DrainDELETEv1.0.0
- Deletes the Integration log drain with the provided `id`DELETEv1.0.0
- Find a project by id or nameGETv1.0.0
- Get a deployment by ID or URLGETv1.0.0
- Get a Domain's configurationGETv1.0.0
- Get a project domainGETv1.0.0
- Get a single checkGETv1.0.0
- Get a single secretGETv1.0.0
- Get a TeamGETv1.0.0
- Get access request statusGETv1.0.0
- Get an AliasGETv1.0.0
- Get an Edge ConfigGETv1.0.0
- Get an Edge Config itemGETv1.0.0
- Get cert by idGETv1.0.0
- Get configurations for the authenticated user or teamGETv1.0.0
- Get Deployment File ContentsGETv1.0.0
- Get Edge Config itemsGETv1.0.0
- Get Edge ConfigsGETv1.0.0
- Get Information for a Single DomainGETv1.0.0
- Get status of Remote Caching for this principalGETv1.0.0
- Get the UserGETv1.0.0
- List aliasesGETv1.0.0
- List all teamsGETv1.0.0
- List all the domainsGETv1.0.0
- List Deployment AliasesGETv1.0.0
- List Deployment BuildsGETv1.0.0
- List Deployment FilesGETv1.0.0
- List existing DNS recordsGETv1.0.0
- List git namespaces by providerGETv1.0.0
- List git repositories linked to namespace by providerGETv1.0.0
- List secretsGETv1.0.0
- List team membersGETv1.0.0
- List User EventsGETv1.0.0
- Query information about an artifactPOSTv1.0.0
- Register or transfer-in a new DomainPOSTv1.0.0
- Remove a domain by nameDELETEv1.0.0
- Retrieve a list of all checksGETv1.0.0
- Retrieve an integration configurationGETv1.0.0
- Retrieve the decrypted value of an environment variable of a project by idGETv1.0.0
- Retrieve the environment variables of a project by id or nameGETv1.0.0
- Retrieves a Configurable Log DrainGETv1.0.0
- Retrieves a list of Configurable Log DrainsGETv1.0.0
- Retrieves a list of Integration log drainsGETv1.0.0
Infrastructure/Vercel
List aliases
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
{
"type": "object",
"properties": {
"domain": {
"description": "Get only aliases of the given domain name",
"items": {
"type": "string"
}
},
"from": {
"type": "number",
"description": "Get only aliases created after the provided timestamp"
},
"limit": {
"type": "number",
"description": "Maximum number of aliases to list from a request"
},
"projectId": {
"type": "string",
"description": "Filter aliases from the given `projectId`"
},
"rollbackDeploymentId": {
"type": "string",
"description": "Get aliases that would be rolled back for the given deployment"
},
"since": {
"type": "number",
"description": "Get aliases created after this JavaScript timestamp"
},
"teamId": {
"type": "string"
},
"until": {
"type": "number",
"description": "Get aliases created before this JavaScript timestamp"
}
},
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
{
"type": "object",
"required": [
"aliases",
"pagination"
],
"properties": {
"aliases": {
"type": "array",
"items": {
"type": "object",
"required": [
"alias",
"created",
"deploymentId",
"projectId",
"uid"
],
"properties": {
"alias": {
"type": "string",
"description": "The alias name, it could be a `.vercel.app` subdomain or a custom domain"
},
"created": {
"type": "string",
"format": "date-time",
"description": "The date when the alias was created"
},
"createdAt": {
"type": "number",
"description": "The date when the alias was created in milliseconds since the UNIX epoch"
},
"creator": {
"type": "object",
"description": "Information of the user who created the alias",
"required": [
"uid",
"email",
"username"
],
"properties": {
"email": {
"type": "string",
"description": "Email of the user who created the alias"
},
"uid": {
"type": "string",
"description": "ID of the user who created the alias"
},
"username": {
"type": "string",
"description": "Username of the user who created the alias"
}
}
},
"deletedAt": {
"type": "number",
"description": "The date when the alias was deleted in milliseconds since the UNIX epoch"
},
"deployment": {
"type": "object",
"description": "A map with the deployment ID, URL and metadata",
"required": [
"id",
"url"
],
"properties": {
"id": {
"type": "string",
"description": "The deployment unique identifier"
},
"meta": {
"type": "string",
"description": "The deployment metadata"
},
"url": {
"type": "string",
"description": "The deployment unique URL"
}
}
},
"deploymentId": {
"type": [
"string",
"null"
],
"description": "The deployment ID"
},
"projectId": {
"type": [
"string",
"null"
],
"description": "The unique identifier of the project"
},
"protectionBypass": {
"type": "object",
"description": "Construct a type with a set of properties K of type T"
},
"redirect": {
"type": [
"string",
"null"
],
"description": "Target destination domain for redirect when the alias is a redirect"
},
"redirectStatusCode": {
"type": [
"number",
"null"
],
"description": "Status code to be used on redirect",
"enum": [
301,
302,
307,
308
]
},
"uid": {
"type": "string",
"description": "The unique identifier of the alias"
},
"updatedAt": {
"type": "number",
"description": "The date when the alias was updated in milliseconds since the UNIX epoch"
}
}
}
},
"pagination": {
"type": "object",
"description": "This object contains information related to the pagination of the current request, including the necessary parameters to get the next or previous page of data.",
"required": [
"count",
"next",
"prev"
],
"properties": {
"count": {
"type": "number",
"description": "Amount of items in the current page."
},
"next": {
"type": [
"number",
"null"
],
"description": "Timestamp that must be used to request the next page."
},
"prev": {
"type": [
"number",
"null"
],
"description": "Timestamp that must be used to request the previous page."
}
}
}
}
}