---
title: "Portal Registrations"
url: "https://nov18-dev.movespot.fyi/apis/portal-registrations-2/versions/c80b6820-00e4-4844-ac53-257ee88f1ff3"
---

# Portal Registrations

OpenAPI specification document.

```json
{"openapi":"3.0.0","info":{"title":"Portal Registrations","version":"3.0.2","description":"N/A (this description is removed during bundling)","contact":{"name":"Kong","url":"https://cloud.konghq.com"}},"paths":{"/api/v3/applications/{applicationId}/registrations":{"get":{"operationId":"list-application-registrations","summary":"List Registrations for App","description":"Lists API registrations for an application.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ApplicationId"},{"$ref":"#/components/parameters/FilterByIdEquality"},{"$ref":"#/components/parameters/FilterByIdEqualityShort"},{"$ref":"#/components/parameters/FilterByStatusEquality"},{"$ref":"#/components/parameters/FilterByStatusEqualityShort"},{"$ref":"#/components/parameters/FilterByAPINameEquality"},{"$ref":"#/components/parameters/FilterByAPINameEqualityShort"},{"$ref":"#/components/parameters/FilterByAPINameContains"}],"responses":{"200":{"$ref":"#/components/responses/ListApiRegistrations"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]}],"tags":["Registrations"]},"post":{"operationId":"create-application-registration","summary":"Register App for API","description":"Registers an application for an API.","parameters":[{"$ref":"#/components/parameters/ApplicationId"}],"requestBody":{"$ref":"#/components/requestBodies/CreateAPIRegistration"},"responses":{"201":{"$ref":"#/components/responses/CreateAPIRegistration"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"portalAccessToken":[]}],"tags":["Registrations"]}},"/api/v3/applications/{applicationId}/registrations/{registrationId}":{"get":{"operationId":"get-application-registration","summary":"Get an App Registration","description":"Retrieves the specified API registration for an application.","parameters":[{"$ref":"#/components/parameters/ApplicationId"},{"$ref":"#/components/parameters/RegistrationId"}],"responses":{"200":{"$ref":"#/components/responses/GetAPIRegistration"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]}],"tags":["Registrations"]},"delete":{"operationId":"delete-application-registration","summary":"Delete App Registration","description":"Unregister an application for an API.","parameters":[{"$ref":"#/components/parameters/ApplicationId"},{"$ref":"#/components/parameters/RegistrationId"}],"responses":{"204":{"description":"The registration has been deleted."},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]}],"tags":["Registrations"]}}},"components":{"parameters":{"ApplicationId":{"name":"applicationId","in":"path","required":true,"description":"Id of the targeted application","schema":{"type":"string","format":"uuid"}},"FilterByAPINameContains":{"name":"filter[api_name][contains]","description":"Filter by contains comparison of the api_name property with a supplied substring","in":"query","required":false,"schema":{"type":"string","example":"good service"}},"FilterByAPINameEquality":{"name":"filter[api_name][eq]","description":"Filter by direct equality comparison of the api_name property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"good service"}},"FilterByAPINameEqualityShort":{"name":"filter[api_name]","description":"Filter by direct equality comparison (short-hand) of the api_name property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"good service"}},"FilterByIdEquality":{"name":"filter[id][eq]","description":"Filter by direct equality comparison of the id property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"5be86298-147b-45ab-bfaf-a1bff97dce39"}},"FilterByIdEqualityShort":{"name":"filter[id]","description":"Filter by direct equality comparison (short-hand) of the id property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"5be86298-147b-45ab-bfaf-a1bff97dce39"}},"FilterByStatusEquality":{"name":"filter[status][eq]","description":"Filter by direct equality comparison of the status property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"approved","enum":["approved","pending","rejected","revoked"]}},"FilterByStatusEqualityShort":{"name":"filter[status]","description":"Filter by direct equality comparison (short-hand) of the status property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"approved","enum":["approved","pending","rejected","revoked"]}},"PageNumber":{"name":"page[number]","description":"Determines which page of the entities to retrieve.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":1}},"PageSize":{"name":"page[size]","description":"The maximum number of items to include per page. The last page of a collection may include fewer items.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":10}},"RegistrationId":{"name":"registrationId","in":"path","required":true,"description":"Contains a unique identifier used by the Portal API for this resource.","schema":{"type":"string","format":"uuid"}}},"schemas":{"CreateApiRegistrationPayload":{"description":"The payload to create a registration.","type":"object","properties":{"api_id":{"description":"The API id required for registration.","type":"string","format":"uuid"}},"additionalProperties":false,"required":["api_id"],"title":"CreateRegistrationPayload"},"ListApiRegistrationsResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GetApiRegistrationResponse"}}},"additionalProperties":false,"required":["data","meta"]},"GetApiRegistrationResponse":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"status":{"description":"The approval status of the registration.","type":"string","enum":["approved","pending","rejected","revoked"]},"api_name":{"description":"The name of the API. This is the name that is displayed in the developer portal.","type":"string"},"api_id":{"description":"Contains a unique identifier used by the Portal API for this resource.","type":"string","format":"uuid"},"api_slug":{"description":"The API `slug` is used in generated URLs to provide human readable paths.\n\nDefaults to `slugify(name + version)`\n","type":"string","example":"my-api-v1","nullable":false},"application_id":{"description":"Contains a unique identifier used by the Portal API for this resource.","type":"string","format":"uuid"}},"additionalProperties":false,"required":["id","status","application_id","api_name","api_id","api_slug","created_at","updated_at"]},"PageMeta":{"description":"Contains pagination query parameters and the total number of objects returned.","type":"object","properties":{"number":{"type":"number","example":1},"size":{"type":"number","example":10},"total":{"type":"number","example":100}},"required":["number","size","total"]},"PaginatedMeta":{"description":"returns the pagination information","type":"object","properties":{"page":{"$ref":"#/components/schemas/PageMeta"}},"required":["page"],"title":"PaginatedMeta"},"UUID":{"description":"Contains a unique identifier used for this resource.","type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"CreatedAt":{"description":"An ISO-8601 timestamp representation of entity creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"UpdatedAt":{"description":"An ISO-8601 timestamp representation of entity update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"BaseError":{"description":"standard error","type":"object","properties":{"status":{"description":"The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","type":"integer","readOnly":true},"title":{"description":"A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true},"type":{"description":"The error type.","type":"string","readOnly":true},"instance":{"description":"Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","type":"string","readOnly":true},"detail":{"description":"A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true}},"required":["status","title","instance","detail"],"title":"Error"},"InvalidRules":{"description":"invalid parameters rules","type":"string","enum":["required","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region","type"],"nullable":true,"readOnly":true},"InvalidParameterStandard":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"$ref":"#/components/schemas/InvalidRules"},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"is a required field","readOnly":true}},"additionalProperties":false,"required":["field","reason"]},"InvalidParameterMinimumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min"],"nullable":false,"readOnly":true},"minimum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must have at least 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","minimum"]},"InvalidParameterMaximumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["max_length","max_items","max"],"nullable":false,"readOnly":true},"maximum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must not have more than 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","maximum"]},"InvalidParameterChoiceItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["enum"],"nullable":false,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"choices":{"type":"array","items":{},"minItems":1,"nullable":false,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","reason","rule","choices"]},"InvalidParameterDependentItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["dependent_fields"],"nullable":true,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"dependents":{"type":"array","items":{},"nullable":true,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","rule","reason","dependents"]},"InvalidParameters":{"description":"invalid parameters","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/InvalidParameterStandard"},{"$ref":"#/components/schemas/InvalidParameterMinimumLength"},{"$ref":"#/components/schemas/InvalidParameterMaximumLength"},{"$ref":"#/components/schemas/InvalidParameterChoiceItem"},{"$ref":"#/components/schemas/InvalidParameterDependentItem"}]},"minItems":1,"nullable":false,"uniqueItems":true},"BadRequestError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","required":["invalid_parameters"],"properties":{"invalid_parameters":{"$ref":"#/components/schemas/InvalidParameters"}}}]},"UnauthorizedError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":401},"title":{"example":"Unauthorized"},"type":{"example":"https://httpstatuses.com/401"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Invalid credentials"}}}]},"NotFoundError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":404},"title":{"example":"Not Found"},"type":{"example":"https://httpstatuses.com/404"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Not found"}}}]},"ConflictError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":409},"title":{"example":"Conflict"},"type":{"example":"https://httpstatuses.com/409"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Conflict"}}}]}},"examples":{"UnauthorizedExample":{"value":{"status":401,"title":"Unauthorized","instance":"kong:trace:8347343766220159418","detail":"Unauthorized"}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"requestBodies":{"CreateAPIRegistration":{"description":"Create an application registration.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApiRegistrationPayload"}}}}},"responses":{"CreateAPIRegistration":{"description":"Registration creation response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApiRegistrationResponse"}}}},"GetAPIRegistration":{"description":"Get registration response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApiRegistrationResponse"}}}},"ListApiRegistrations":{"description":"Get registrations response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApiRegistrationsResponse"}}}},"BadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/UnauthorizedExample"}}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}},"Conflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}}},"securitySchemes":{"portalAccessToken":{"type":"apiKey","in":"cookie","name":"portalaccesstoken","description":"The Developer portal cookie is meant to be used by the Developer API to authenticate with.\n"}}},"tags":[{"name":"Registrations","description":"The API for Konnect Portal application registrations. If the portal is public\nall of the described endpoints will return a 404 error\n"}]}
```
